Skip to content

Commit 04c80da

Browse files
committed
readme updated
1 parent b1963cb commit 04c80da

File tree

1 file changed

+33
-23
lines changed

1 file changed

+33
-23
lines changed

README.md

Lines changed: 33 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
# Github-Admin: Collection of GitHub CRUD Boilerplate Code
44

5-
<p id="intro">Github-Admin is a collection of boilerplate code for performing CRUD operations on GitHub repositories. Built with the @octokit/rest library, it simplifies tasks such as creating, updating, and deleting repositories using the GitHub REST API.
6-
</p>
5+
<p id="intro">**Github-Admin** is a streamlined collection of boilerplate code designed to simplify the process of performing CRUD (Create, Read, Update, Delete) operations on GitHub repositories. Built with the powerful `@octokit/rest` library, this tool enables developers to effortlessly manage their repositories using the GitHub REST API. Whether you're creating new repositories, updating existing ones, or removing those that are no longer needed, Github-Admin takes the complexity out of repository management.</p>
76

87
### Supported Platforms
98

@@ -102,21 +101,22 @@
102101

103102
## Features and Benefits ✨
104103

105-
- **add_secret.js**: Manage and add secrets to repositories.
106-
- **create_file.js**: Create new files within a repository.
107-
- **delete_file.js**: Delete files from a repository.
108-
- **list_repo.js**: List all repositories associated with a user or organization.
109-
- **read_file.js**: Read content from files within a repository.
110-
- **trigger_wf.js**: Trigger workflows and actions in a repository.
111-
- **wf_perm.js**: Manage workflow permissions.
104+
- **Easy Repository Creation**: Quickly set up new repositories with minimal configuration.
105+
- **Effortless Updates**: Seamlessly update repository details such as name, description, and visibility.
106+
- **Repository Deletion**: Safely delete repositories you no longer need.
107+
- **Listing Repositories**: Retrieve a comprehensive list of repositories associated with your GitHub account.
108+
- **File Management**: Create, read, and delete files within a repository effortlessly.
109+
- **Secret Management**: Securely manage and add secrets to repositories.
110+
- **Workflow Automation**: Trigger workflows and manage permissions for GitHub Actions.
112111

113112
## Use Cases ✅
114113

115-
- Automate GitHub repository setup
116-
- Implement custom repository management tools
117-
- Integrate repository CRUD operations into CI/CD pipelines
118-
- Develop GitHub management applications
119-
- Enhance repository automation scripts
114+
- **Automated Repository Management**: Integrate Github-Admin into CI/CD pipelines to automate repository setup and teardown.
115+
- **Project Bootstrapping**: Quickly create and configure repositories for new projects.
116+
- **Repository Cleanup**: Automate the deletion of obsolete or unused repositories.
117+
- **Bulk Updates**: Efficiently apply updates to multiple repositories in one go.
118+
- **GitHub Organization Management**: Manage repositories within GitHub organizations with ease.
119+
- **Custom Tools Development**: Use Github-Admin as a foundation for building custom GitHub management tools.
120120

121121
---
122122

@@ -294,14 +294,24 @@ Thanks to [Keegan Campbell](https://github.com/kfcampbell), [Nick Floyd](https:/
294294
#### Topics
295295

296296
<ul id="keywords">
297-
<li>GitHub</li>
298-
<li>CRUD</li>
299-
<li>Boilerplate</li>
297+
<li>GitHub API</li>
298+
<li>CRUD operations</li>
299+
<li>Repository management</li>
300300
<li>Octokit</li>
301-
<li>API</li>
302-
<li>Repositories</li>
303-
<li>Management</li>
304-
<li>Code</li>
305-
<li>Automation</li>
306-
<li>Utilities</li>
301+
<li>REST API</li>
302+
<li>GitHub automation</li>
303+
<li>GitHub repositories</li>
304+
<li>API integration</li>
305+
<li>Repository setup</li>
306+
<li>OAuth authentication</li>
307+
<li>Error handling</li>
308+
<li>CI/CD integration</li>
309+
<li>Project management</li>
310+
<li>Boilerplate code</li>
311+
<li>Automation tools</li>
312+
<li>Developer tools</li>
313+
<li>GitHub organization</li>
314+
<li>API tools</li>
315+
<li>Repository creation</li>
316+
<li>Repository deletion</li>
307317
</ul>

0 commit comments

Comments
 (0)