From af865924902ec6d63fc06e24fa785514bbbbfd7e Mon Sep 17 00:00:00 2001
From: code liturgy <rs@codeliturgy.com>
Date: Mon, 7 Nov 2022 08:47:36 -0500
Subject: [PATCH] Add README

---
 Sharp.Augeas/Dockerfile | 18 ------------------
 Sharp.Augeas/README.md  | 21 +++++++++++++++++++++
 2 files changed, 21 insertions(+), 18 deletions(-)
 delete mode 100644 Sharp.Augeas/Dockerfile
 create mode 100644 Sharp.Augeas/README.md

diff --git a/Sharp.Augeas/Dockerfile b/Sharp.Augeas/Dockerfile
deleted file mode 100644
index c9f4940..0000000
--- a/Sharp.Augeas/Dockerfile
+++ /dev/null
@@ -1,18 +0,0 @@
-FROM mcr.microsoft.com/dotnet/runtime:6.0 AS base
-WORKDIR /app
-
-FROM mcr.microsoft.com/dotnet/sdk:6.0 AS build
-WORKDIR /src
-COPY ["TestConsummingAug/TestConsummingAug.csproj", "TestConsummingAug/"]
-RUN dotnet restore "TestConsummingAug/TestConsummingAug.csproj"
-COPY . .
-WORKDIR "/src/TestConsummingAug"
-RUN dotnet build "TestConsummingAug.csproj" -c Release -o /app/build
-
-FROM build AS publish
-RUN dotnet publish "TestConsummingAug.csproj" -c Release -o /app/publish
-
-FROM base AS final
-WORKDIR /app
-COPY --from=publish /app/publish .
-ENTRYPOINT ["dotnet", "TestConsummingAug.dll"]
diff --git a/Sharp.Augeas/README.md b/Sharp.Augeas/README.md
new file mode 100644
index 0000000..2468846
--- /dev/null
+++ b/Sharp.Augeas/README.md
@@ -0,0 +1,21 @@
+# Sharp.Augeas
+
+
+Sharp.Augeas implements an abstraction to be able to use augeas with C# / .NET. it provides a managed class that takes into account the life cycle of the application. 
+
+Note: Currently the focus is abstractions with a focus on handling Apache configurations. In the future these abstractions may be associated with various other configurations.
+
+## Instructions
+
+### Ccopy Native wrapper library 
+
+`cd Sharp.Augeas && ./copyLibrary.sh`
+
+### Augeas
+
+Augeas must be installed on the system, and the environment variable "AUG_LENS_PATH" must be populated, otherwise an exception will be thrown.
+
+* Mac Os os example, after installing using brew:
+`export AUG_LENS_PATH=/opt/homebrew/share/augeas/lenses/dist`
+
+* Debian / Ubuntu (Using package manager): `export AUG_LENS_PATH=/opt/homebrew/share/augeas/lenses/dist`
\ No newline at end of file