📝 feat: update readme and license

.npmignore

@@ -1,4 +1,7 @@
 /node_modules
 /src
+/assets
+.github/
+coverage/
 
 tsconfig.json

LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) Meta Platforms, Inc. and affiliates.
+Copyright Contributors to the RunScript project.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,3 +1,86 @@
-# RunScript
+<p align="center">
+  <a href="https://www.npmjs.com/package/@gabsf-dev/run-script"><img src="https://img.shields.io/npm/v/%40gabsf-dev%2Frun-script
+  " alt="npm version"></a>
+  <a href="https://github.com/gabsf-dev/run-script/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="RunScript is released under the MIT license."></a>
+</p>
+<p align="center">
+  <a href="https://github.com/gabsf-dev/run-script/blob/main/.github/workflows/publish.yml"><img alt="GitHub CI Status" src="https://img.shields.io/github/actions/workflow/status/gabsf-dev/run-script/publish.yml?branch=main&logo=github&label=CI
+  "></a>
+</p>
+
+<!-- A spacer -->
+<p>&nbsp;</p>
+
+<h1 align="center">RunScript</h1>
 
 The effortlessly way to run your package.json scripts
+
+## Getting Started
+
+To use `run-script` it's simple as to run:
+
+```bash
+npx @gabsf-dev/run-script
+```
+
+Or to install globally:
+
+```bash
+npm i -g @gabsf-dev/run-script
+```
+
+and run it using:
+
+```bash
+run-script
+```
+
+After that, just choose the script that you want to run, and RunScript make the rest, since choosing `npm` or `yarn` to run your script based on the lock file present in the folder, to logging all of the script execution for you.
+
+## Flags
+
+RunScript provides the following flags:
+
+- _-V, --version_
+
+Logs the RunScript current version.
+
+```bash
+npx @gabsf-dev/run-script -V
+```
+
+- _-h, --help_
+
+Logs the RunScript help.
+
+```bash
+npx @gabsf-dev/run-script -h
+```
+
+- _-v, --view_
+
+Only show the scripts listed in your `package.json` in a table format.
+
+```bash
+npx @gabsf-dev/run-script --view
+```
+
+<p align="center">
+  <img src="./assets/run-script-view.png" alt="RunScript view example">
+</p>
+
+- _--ai_
+
+With the `--ai` flag, you can receive ai thoughts about the scripts presents in the `package.json`. It's a coming soon feature, so stay tuned for the future updates.
+
+```bash
+npx @gabsf-dev/run-script --ai
+```
+
+## License
+
+RunScript is [MIT licensed](./LICENSE).
+
+## Copyright
+
+Copyright Contributors to the RunScript project.