Update README.md

salihgueler · Aug 4, 2022 · 43bfee8 · 43bfee8
1 parent 0022319
commit 43bfee8
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,2 +1,8 @@
+# 0.2.1
+- Update README.md to have proper steps
+
+# 0.2.0
+- Using post and pregen hooks to provide easier installation.
+- Update README.md
 # 0.1.0
 - Initial release
diff --git a/README.md b/README.md
@@ -19,6 +19,16 @@ If you do not know how to do it, you can check the [official documentation](http
 
 ## How to use 🚀
 
+First create your mason project by running `mason init` on any folder that you want.
+
+Afterwards, add the library to your project.
+
+```shell
+mason add amplify_starter
+```
+
+Now generate the files. 
+
 You can either fill in the variables on your CLI:
 
 ```shell

diff --git a/brick.yaml b/brick.yaml
@@ -2,7 +2,7 @@ name: amplify_starter
 description: A highly opinionated AWS Amplify starter project with Authenticator, Amplify Datastore and bloc state management.
 repository: https://github.com/salihgueler/amplify_starter
 
-version: 0.1.0
+version: 0.2.1
 
 environment:
   mason: ">=0.1.0-dev.26 <0.1.0"