readme.md maj

This commit is contained in:
bcharest 2023-06-12 22:46:35 -04:00
parent 8bb6c99d39
commit 9547004867
1 changed files with 7 additions and 7 deletions

View File

@ -1,10 +1,10 @@
# Project Creator # Project Creator
This is a simple CLI app to create Github project. This is a simple CLI app to create a startup structure Github or Gitea project.
## Description ## Description
The Project Creator GO app allows you to: The **KodeStarter** app allows you to:
- Create a Github project (repo) - Create a Github project (repo)
- Initialize a Git repository - Initialize a Git repository
@ -19,7 +19,7 @@ To build and run the app:
```bash ```bash
go build go build
./prj-creator.exe ./kode-starter.exe
``` ```
This will show the help menu. The main commands are: This will show the help menu. The main commands are:
@ -30,13 +30,13 @@ This will show the help menu. The main commands are:
To create a project: To create a project:
```bash ```bash
./prj-creator.exe create -t <github_token> -o <org_name> -n <project_name> -d <description> -p <private|false> ./kode-starter.exe create -t <github_token> -o <org_name> -n <project_name> -d <description> -p <private|false>
``` ```
For example: For example:
```bash ```bash
./prj-creator.exe create -t abc123 -o myorg -n myproject -d "A test project" -p false ./kode-starter.exe create -t abc123 -o myorg -n myproject -d "A test project" -p false
``` ```
This will: This will:
@ -50,13 +50,13 @@ This will:
To list Github orgs and repos: To list Github orgs and repos:
```bash ```bash
./prj-creator.exe list -t <github_token> -o <org_name> ./kode-starter.exe list -t <github_token> -o <org_name>
``` ```
For example: For example:
```bash ```bash
./prj-creator.exe list -t abc123 -o myorg ./kode-starter.exe list -t abc123 -o myorg
``` ```
This will list the repos in the `myorg` organization. This will list the repos in the `myorg` organization.