Skip to content

Commit d8337de

Browse files
committed
docs(README): initial version
1 parent b908302 commit d8337de

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Create new Octoherd Script
2+
3+
> CLI to create a new folder and repository for an Octoherd Script
4+
5+
## Usage
6+
7+
```shell
8+
npm init octoherd-script
9+
```
10+
11+
## What it does
12+
13+
- Creates a new folder on your machine
14+
- Inits git in the new folder
15+
- Add `LICENSE`, `CODE_OF_CONDUCT.md`, `README.md` and issue templates
16+
- Creates a repository
17+
- Adds repository as `git remote add origin <url>`
18+
- Push the files to main
19+
- Creates a new local branch called `initial-version`
20+
- Adds files for the script, CLI, and more meta files
21+
- Creates a pull request
22+
- Adds branch protection (if possible)
23+
- Adds workflow files for tests and automated releases
24+
25+
## Contribute
26+
27+
Pull requests welcome!
28+
29+
## License
30+
31+
[ISC](LICENSE)

0 commit comments

Comments
 (0)