Update README.md

README.md

@@ -0,0 +1,64 @@
+# OctoSuite
+
+TUI-based toolkit for GitHub data analysis.
+
+## Overview
+
+OctoSuite provides a terminal interface for exploring and exporting GitHub data. Access information about users,
+repositories, organizations, and search across GitHub's platform.
+
+## Features
+
+- **User Data** - View profiles, repositories, followers, organizations, and activity, e.t.c.
+- **Repository Data** - Access repository details, commits, issues, releases, and contributors
+- **Organisation Data** - Explore organisation profiles, members, and repositories
+- **Search** - Search across repositories, users, commits, issues, and topics
+- **Export** - Save data in JSON, CSV, or HTML formats
+
+## Installation
+
+### PyPI
+
+```bash
+pip install octosuite
+```
+
+### Build from source
+
+```bash
+# Clone repository
+git clone https://github.com/bellingcat/octosuite.git
+
+# Move to octosuite directory
+cd octosuite
+
+# Build and install (uses uv)
+make install
+
+# If you dont have uv installed, you can install directly with pip:
+pip install .
+
+# Run
+octosuite
+```
+
+> [!Note]
+> You can run octosuite with commands `octosuite`, or `ocs`
+
+## Usage
+
+Navigate using <kbd>↑</kbd><kbd>↓</kbd> and <kbd>Enter</kbd> to select options. The interface guides you through
+selecting a
+data source
+and
+choosing what information to retrieve. Preview the results and optionally export them in your preferred format.
+
+## License
+
+### MIT License
+
+See the LICENSE file for details. License information is also available through the application's main menu.
+
+## Contributing
+
+Contributions are welcome. Please submit pull requests or open issues for bugs and feature requests. Good luck!

pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "octosuite"
 version = "4.0.0-beta"
-description = "TUI-based toolkit for GitHub-data analysis."
+description = "TUI-based toolkit for GitHub data analysis."
 readme = "README.md"
 license = "MIT"
 authors = [
@@ -33,4 +33,5 @@ dev = [
 ]
 
 [project.scripts]
-octosuite = "octosuite.app:start"
+octosuite = "octosuite.app:start"
+ocs = "octosuite.app:start"