Update docs&readme

README.md

@@ -1,17 +1,70 @@
 # GitHub Actions Manager (GAMA)
 
-GAMA is a terminal-ui tool designed to simplify the management of your GitHub Actions workflows. It provides functionality to list and trigger workflows directly from your terminal.
+GAMA is a powerful terminal-based user interface tool designed to streamline the management of GitHub Actions workflows. It allows developers to list, trigger, and manage workflows with ease directly from the terminal.
 
-## Features
+<img alt="gama demo" src="docs/gama.gif" width="600"/>
 
-- You can use more than 10 workflow inputs.
-- List all workflows in a repository.
-- Trigger specific workflows using their ID.
+## Key Features
+
+- **Extended Workflow Inputs**: Supports more than 10 workflow inputs using JSON format.
+- **Workflow History**: Conveniently list all historical runs of workflows in a repository.
+- **Discoverability**: Easily list all triggerable (dispatchable) workflows in a repository.
+- **Workflow Management**: Trigger specific workflows with custom inputs.
+
+## Getting Started
+
+### Prerequisites
+Before using GAMA, you need to generate a GitHub token. Follow these [instructions](docs/generate_github_token/README.md) to create your token.
+
+### Configuration
+
+#### YAML Configuration
+Place a `.gama.yaml` file in your home directory with the following content:
+
+```yaml
+github:
+  token: <your github token>
+```
+
+#### Environment Variable Configuration
+Alternatively, you can use an environment variable:
+
+```bash
+GITHUB_TOKEN="<your github token>" gama
+```
 
 ## Installation
 
-GAMA can be installed using the `go get` command:
+### Using Go Get
+
+Install GAMA using Go:
 
 ```bash
-go get github.com/termkit/gama@v1.0.0
-```
+go install github.com/termkit/gama@latest
+```
+
+### Using Docker
+
+Run GAMA in a Docker container:
+
+```bash
+docker run --rm -it --env GITHUB_TOKEN="<your github token>" termkit/gama:latest
+```
+
+### Download Binary
+
+Download the latest binary from the [releases page](https://github.com/termkit/gama/releases).
+
+---
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+## License
+
+Distributed under the GNU GENERAL PUBLIC LICENSE Version 3. See `LICENSE` for more information.
+
+## Contact&Author
+
+[Engin Açıkgöz](https://github.com/canack)

docs/generate_github_token/README.md

@@ -0,0 +1,28 @@
+### Generate GitHub Token from GAMA ("Fine-Grained Token")
+
+Generate a GitHub token with specific permissions for optimal use with GAMA. Follow these steps:
+
+1. **Open the Fine-Grained Token Page**
+    - Navigate to the fine-grained token page.
+    - Click on the "Generate new token" button.
+
+2. **Choose Repositories**
+    - Decide the scope of the token: `All repositories` or `Only selected repositories`.
+      ![Token Repositories Selection](repos.png)
+
+3. **Set Required Permissions**
+    - Scroll through the permissions list and enable the following:
+
+        - **First Permission**: Necessary to trigger workflows.
+          ![Permission to Run Workflows](perm1.png)
+
+        - **Second Permission**: Essential to list triggerable workflows.
+          ![Permission to Read Workflows](perm2.png)
+
+        - **Third Permission**: Required to read repository contents, enabling workflow triggering.
+          ![Permission to Read Repository Contents](perm3.png)
+
+4. **Finalize**
+    - After setting the permissions, complete the token generation process.
+
+Now, you can utilize this token with GAMA to manage GitHub Actions workflows effectively.