diff --git a/README.md b/README.md index 530c97a..83fca42 100644 --- a/README.md +++ b/README.md @@ -16,11 +16,56 @@ 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 +
+See details + +- **User** - Get user data + - Profile + - Repositories + - Subscriptions + - Starred + - Followers + - Following + - Organizations + - Gists + - Events + - Received Events +- **Repository** - Get repository data + - Profile + - Forks + - Issues + - Issue Events + - Events + - Assignees + - Branches + - Tags + - Languages + - Stargazers + - Subscribers + - Commits + - Comments + - Releases + - Deployments + - Labels +- **Organisation** - Get organisation data + - Profile + - Repositories + - Events + - Hooks + - Issues + - Members +- **Search** - Search GitHub + - Repositories + - Users + - Commits + - Issues + - Topics +- **Export** - Export data + - JSON + - CSV + - HTML + +
## Installation @@ -50,7 +95,7 @@ octosuite ``` > [!Note] -> You can run octosuite with commands `octosuite`, or `ocs` +> You can then run octosuite with command `octosuite` ## Usage diff --git a/pyproject.toml b/pyproject.toml index 856cf4d..fad82d5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -33,5 +33,4 @@ dev = [ ] [project.scripts] -octosuite = "octosuite.app:start" -ocs = "octosuite.app:start" \ No newline at end of file +octosuite = "octosuite.app:start" \ No newline at end of file