readme.md maj
This commit is contained in:
parent
8bb6c99d39
commit
9547004867
14
readme.md
14
readme.md
@ -1,10 +1,10 @@
|
||||
# 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
|
||||
|
||||
The Project Creator GO app allows you to:
|
||||
The **KodeStarter** app allows you to:
|
||||
|
||||
- Create a Github project (repo)
|
||||
- Initialize a Git repository
|
||||
@ -19,7 +19,7 @@ To build and run the app:
|
||||
|
||||
```bash
|
||||
go build
|
||||
./prj-creator.exe
|
||||
./kode-starter.exe
|
||||
```
|
||||
|
||||
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:
|
||||
|
||||
```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:
|
||||
|
||||
```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:
|
||||
@ -50,13 +50,13 @@ This will:
|
||||
To list Github orgs and repos:
|
||||
|
||||
```bash
|
||||
./prj-creator.exe list -t <github_token> -o <org_name>
|
||||
./kode-starter.exe list -t <github_token> -o <org_name>
|
||||
```
|
||||
|
||||
For example:
|
||||
|
||||
```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.
|
||||
|
Loading…
Reference in New Issue
Block a user