Update readme

Author: gonuit

CHANGELOG.md

@@ -1,4 +1,4 @@
-## 0.7.0-dev.4
+## 0.7.0-dev.6
 
 ### BREAKING CHANGES
 

README.md

@@ -1,79 +1,41 @@
 # Run Pubspec Script (RPS)
 
-Define and use scripts from your _pubspec.yaml_ file.
+RPS is a dart script manager that allows you to define and use scripts from the _pubspec.yaml_ file.
 
-## Getting started
 
-1. Install this package.
+## Features 
+<!-- no toc -->
+- [🪆 Nesting](#nesting) 
+- [🔗 References](#references) 
+- [🪝 Hooks](#hooks) 
+- [💻 Platform specific scripts](#platform-specific-scripts) 
 
-   ```bash
-   dart pub global activate rps
-   ```
-
-2. Define script inside the pubspec.yaml
-
-   ```yaml
-   name: my_great_app
-   version: 1.0.0
-
-   scripts:
-     # run is a default script. To use it, simply type
-     # in the command line: "rps" - that's all!
-     run: "flutter run -t lib/main_development.dart --flavor development"
-     # you can define more commands like this: "rps gen"
-     gen: "flutter pub run build_runner watch --delete-conflicting-outputs"
-     # and even nest them!
-     build:
-       # You can use hooks to! (and even nest them!)
-       $before: flutter pub get
-       $after: echo "Build done!"
-       android:
-         # rps build android apk
-         apk: "flutter build --release apk --flavor production"
-         # rps build android appbundle
-         appbundle: "flutter build --release appbundle --flavor production"
-         # and so on...
-     # too long command? no problem! define alias using reference syntax!
-     bab: $build android appbundle
-     # as simple as typing "rps baa"
-     baa: $build android apk
-     # some commands may vary from platform to platform
-     # but that's not a problem
-     clear:
-       # use the $script key to define platform specific scripts
-       $script:
-         # define the default script
-         $default: rm -rf ./cache
-         # And different script for the windows platform.
-         $windows: rd /s /q ./cache
-         # now "rps clear" will work on any platform!
-
-     # the rest of your pubspec file...
-   dependencies:
-     path: ^1.7.0
-   ```
+## Quick start 🚀
 
+1. Install this package.
+    ```bash
+    dart pub global activate rps --version 0.7.0-dev.6
+    ```
+2. Define scripts inside the pubspec.yaml
+      ```yaml
+      scripts:
+        gen: flutter pub run build_runner build --delete-conflicting-outputs
+      ```
 3. Use your custom command.
-
-   Like this `gen` command that we defined in the previous step:
-
-   ```bash
-   rps gen
-   ```
-
-   instead of
-
-   ```bash
-    flutter pub run build_runner watch --delete-conflicting-outputs
-   ```
-
+    ```bash
+    rps gen
+    # you can also provide additional arguments
+    rps gen --verbose
+    ```
 4. Safe a time and become a power user! 😈
+    
+    Less time typing long commands more time watching funny cats. 🐈
 
-   Less time typing long commands more time watching funny cats. 🐈
+# Features
 
-## Nesting
+## 🪆 Nesting
 
-Nest your commands to group them contextually and make them easier to understand 🧪
+Nest your commands to group them contextually and make them easier to understand.
 
 ```yaml
 scripts:
@@ -93,7 +55,7 @@ Use with ease 😏
 rps build android apk
 ```
 
-## References
+## 🔗 References
 
 Sometimes you may want to create a command alias (e.g. a shorter version of it) or simply pass the execution of a hook to another command. This is where references come to the rescue! ⛑
 
@@ -111,19 +73,20 @@ scripts:
 
 References can also be used with `$before` and `$after` hooks.
 
-## Hooks
+## 🪝 Hooks
+
 
 To enable hooks define the `$before` and/or `$after` keys for your script command.
 
 ```yaml
 scripts:
-  hooks:
+  hello:
     $before: echo "hello before" # executed before the $script
     $script: echo "hello script"
     $after: echo "hello after" # executed after $script
 ```
 
-Execute by calling the `rps hooks`.
+All hooks will be executed in the specified order when calling the `rps hello` command.
 
 You can also combine multiple scripts using references!
 
@@ -140,7 +103,7 @@ scripts:
     $script: flutter build apk
 ```
 
-But wait a minute! The hooks can also be nested!
+You can also nest hooks to provide an easy-to-read workflow for all grouped commands!
 
 ```yaml
 # Order when executing: "rps generator build"
@@ -156,7 +119,7 @@ scripts:
 
 You don't have to worry about cyclic references 🔄, RPS will keep track of them and notify you in case of a problem 😏.
 
-## Platform specific scripts
+## 💻 Platform specific scripts
 
 Do you work on multiple platforms? Need to use many different commands and always forget which one to use? This is what you've been waiting for! 🛠
 
@@ -182,18 +145,59 @@ You are on MacOs!
 
 This can be useful for commands like `rm -rf`, which in Windows.... `rd /s /q`, you know what I mean, it can be helpful, right?
 
+## 🔎 Overview example
+
+```yaml
+name: my_great_app
+version: 1.0.0
+
+scripts:
+  # run is a default script. To use it, simply type
+  # in the command line: "rps" - that's all!
+  run: "flutter run -t lib/main_development.dart --flavor development"
+  # you can define more commands like this: "rps gen"
+  gen: "flutter pub run build_runner watch --delete-conflicting-outputs"
+  # and even nest them!
+  build:
+    # You can use hooks to! (and even nest them!)
+    $before: flutter pub get
+    $after: echo "Build done!"
+    android:
+      # rps build android apk
+      apk: 
+        $before: echo "Building android apk..."
+        $script: "flutter build --release apk --flavor production"
+      # rps build android appbundle
+      appbundle: "flutter build --release appbundle --flavor production"
+      # and so on...
+  # too long command? no problem! define alias using reference syntax!
+  bab: $build android appbundle
+  # as simple as typing "rps baa"
+  baa: $build android apk
+  # some commands may vary from platform to platform
+  # but that's not a problem
+  clear:
+    # use the $script key to define platform specific scripts
+    $script:
+      # define the default script
+      $default: rm -rf ./app/cache
+      # And different script for the windows platform.
+      $windows: rd /s /q app\cache
+      # now "rps clear" will work on any platform!
+
+  # the rest of your pubspec file...
+dependencies:
+  path: ^1.7.0
+```
+
 ---
 
-## Motivation
+## 📈 Motivation
 
 I got bored of typing the same long commands over and over again... I even got bored of pressing that boring (and even small on a MacBook) up arrow key to find my previous command in history. So, as befits a programmer, to save time, I spent more time writing this library than searching/writing commands for the last year...
 
 ![stonks](./stonks.jpg)
 
-## Soon
-
-- Further hooks improvements.
-
 ---
 
-Hey you! This package is still in development (bugs may occur 🐛😏).
+Hey you! This package is still in development (errors and API changes can still occur 🐛😏).

pubspec.yaml

@@ -1,6 +1,6 @@
 name: rps
 description: rps (Run Pubspec Script) allows you to define and run scripts from pubspec.yaml.
-version: 0.7.0-dev.4
+version: 0.7.0-dev.6
 repository: https://github.com/gonuit/rps
 homepage: https://github.com/gonuit/rps
 issue_tracker: https://github.com/gonuit/rps/issues