Set version and document usage.

dam5s · Sep 6, 2023 · 3a36c12 · 3a36c12
1 parent 81a9a9e
commit 3a36c12
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,19 @@
+# Cyclic Dependency Checks
+
+This is a small cyclic dependency checker for Dart projects.
+
+## Setup
+
+From inside one of your Dart projects
+
+```
+dart pub add cyclic_dependency_checks --git-url=https://github.com/dam5s/cyclic_dependency_checks.git --git-ref=release/0.1.0
+```
+
+## Running it
+
+Again, from inside your Dart project
+
+```
+dart run cyclic_dependency_checks .
+```
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,5 +1,6 @@
 name: cyclic_dependency_checks
 description: Cyclic Dependency checks for dart projects
+version: 0.1.0
 
 environment:
   sdk: '>=3.0.5 <4.0.0'