Add example READMEs

huntcsg · Jun 24, 2019 · cf0a2f9 · cf0a2f9
1 parent 9d0103b
commit cf0a2f9
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 0 deletions.
diff --git a/examples/alembic/README.md b/examples/alembic/README.md
@@ -0,0 +1,20 @@
+# Instructions
+
+1. Install package and dependencies
+    ```bash
+        $ pip install sqlalchemy-postgresql-audit
+        $ pip install psycopg2
+        $ pip install alembic
+        $ pip install -e test-app
+
+2. Run
+
+    ```bash
+        $ docker-compose up -d
+
+3. Run
+    
+    ```bash
+       $ alembic upgrade head
+
+4. Database now has tables, audit tables, and triggers.
diff --git a/examples/plugin/README.md b/examples/plugin/README.md
@@ -0,0 +1,19 @@
+# Instructions
+
+1. Install package and dependencies
+    ```bash
+        $ pip install sqlalchemy-postgresql-audit
+        $ pip install psycopg2
+
+2. Run
+
+    ```bash
+        $ docker-compose up -d
+
+3. Run
+    
+    ```bash
+       $ python plugin.py
+
+4. Database now has tables, audit tables, and triggers.
+
diff --git a/examples/simple/README.md b/examples/simple/README.md
@@ -0,0 +1,18 @@
+# Instructions
+
+1. Install package and dependencies
+    ```bash
+        $ pip install sqlalchemy-postgresql-audit
+        $ pip install psycopg2
+
+2. Run
+
+    ```bash
+        $ docker-compose up -d
+
+3. Run
+    
+    ```bash
+       $ python simple.py
+
+4. Database now has tables, audit tables, and triggers.