example -> examples

dillonstreator · Dec 17, 2023 · 5f2b40c · 5f2b40c
1 parent ee1a3df
commit 5f2b40c
Show file tree

Hide file tree

Showing 8 changed files with 14 additions and 3 deletions.
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -23,9 +23,9 @@ jobs:
     - name: Install dependencies
       run: yarn install
 
-    - name: Remove example dir
+    - name: Remove examples dir
       run: |
-        rm -rf example
+        rm -rf examples
 
     - name: Run the tests
       run: yarn test:ci

diff --git a/README.md b/README.md
@@ -17,3 +17,14 @@
     <img alt="" src="https://www.codefactor.io/repository/github/dillonstreator/txob/badge">
   </a>
 </p>
+
+
+## Installation
+
+```sh
+npm install txob
+```
+
+## Usage
+
+[examples](./examples)
diff --git a/example/pg/docker-compose.yml → examples/pg/docker-compose.yml b/example/pg/docker-compose.yml → examples/pg/docker-compose.yml
diff --git a/example/pg/index.ts → examples/pg/index.ts b/example/pg/index.ts → examples/pg/index.ts
diff --git a/example/pg/package.json → examples/pg/package.json b/example/pg/package.json → examples/pg/package.json
diff --git a/example/pg/tsconfig.json → examples/pg/tsconfig.json b/example/pg/tsconfig.json → examples/pg/tsconfig.json
diff --git a/example/pg/yarn.lock → examples/pg/yarn.lock b/example/pg/yarn.lock → examples/pg/yarn.lock
diff --git a/tsconfig.json b/tsconfig.json
@@ -10,5 +10,5 @@
         "outDir": "dist",
         "declaration": true
     },
-    "exclude": ["example", "dist", "node_modules", "./**/*.test.ts"]
+    "exclude": ["examples", "dist", "node_modules", "./**/*.test.ts"]
 }