Skip to content

Commit 138e8f6

Browse files
authored
docs(README): Prompts for script options and adds according documentation to the README.md file
1 parent 4e740db commit 138e8f6

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,15 @@ npm init octoherd-script
1313
- Creates a new folder on your machine
1414
- Inits git in the new folder
1515
- Add `LICENSE`, `CODE_OF_CONDUCT.md`, `README.md` and issue templates
16+
- Prompts for script options and adds according documentation to the `README.md` file
1617
- Creates a repository
1718
- Adds repository as `git remote add origin <url>`
1819
- Push the files to main
1920
- Creates a new local branch called `initial-version`
2021
- Adds files for the script, CLI, and more meta files
21-
- Creates a pull request
2222
- Adds branch protection (if possible)
23-
- Adds workflow files for tests and automated releases
23+
- Adds workflow files for tests and automated releases to GitHub and npm
24+
- Creates a pull request with further instructions
2425

2526
## Contribute
2627

0 commit comments

Comments
 (0)