Skip to content

Commit

Permalink
docs: improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
r4ai committed Apr 10, 2024
1 parent 5650270 commit cd04edf
Showing 1 changed file with 21 additions and 8 deletions.
29 changes: 21 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,27 @@
# templates

個人用のテンプレート集
[![CI](https://github.com/r4ai/templates/actions/workflows/ci.yml/badge.svg)](https://github.com/r4ai/templates/actions/workflows/ci.yml)
[![CD](https://github.com/r4ai/templates/actions/workflows/cd.yml/badge.svg)](https://github.com/r4ai/templates/actions/workflows/cd.yml)

## Usage
Templates for personal projects

`git clone` して、必要なディレクトリだけ残して使う方法:
## Quick Start

```sh
git clone --depth 1 https://github.com/r4ai/templates.git
mv templates/templates/<template-name> <your-project-name>
rm -rf templates
cd <your-project-name>
Run the following command to create a new project:

```
bun create @r4ai/project
```

Answer the questions and you're ready to go!

> [!NOTE]
> For other package managers, use the following commands:
>
> | Package Manager | Command |
> | --------------- | ----------------------------------- |
> | npm | `npm create @r4ai/project` |
> | pnpm | `pnpm create @r4ai/project` |
> | yarn | `yarn create @r4ai/project` |
> | bun | `bun create @r4ai/project` |
> | deno | `deno run npm:@r4ai/create-project` |

0 comments on commit cd04edf

Please sign in to comment.