Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Morgandri1 committed Jul 10, 2024
1 parent 1988d59 commit 47d05e2
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
# mkprj
mkprj is a simple cli utility to make project creation more seamless. It allows you to create a project with most language's templates and then open it in your favorite editor.

### This project seems pointless
It is, to be honest. But, I find the commands ran just to start a new project are enough of a point of friction (for me) to warrant a tool like this. I hope you find it useful too.

### Supported npm alternatives
- npm (obviously)
- yarn
- deno
- bun

###

# Installation
```bash
cargo install --git https://github.com/Morgandri1/mkprj
Expand All @@ -14,4 +25,4 @@ The options are as follows:
- `--node_command`: Your javascript/node command. The default is `npm`, but you can change it to any one of `bun`, `yarn`, `deno`.

# Usage
mkprj is a fairly simple app to use. Simply run `mkprj <project_name> --<language>` to create a project. For example, to create a rust project, you would run `mkprj my_project --rust`.
mkprj is a fairly simple app to use. Simply run `mkprj <project_name> --<language>` to create a project. For example, to create a rust project, you would run `mkprj my_project --rust`. But, if you don't want to use a language template, you can simply run `mkprj my_project` and it will create a project with a git repository.

0 comments on commit 47d05e2

Please sign in to comment.