Skip to content

Commit

Permalink
docs(readme): update Usage
Browse files Browse the repository at this point in the history
  • Loading branch information
sebkolind committed Aug 1, 2024
1 parent 73a2ab9 commit c41dfd7
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,24 @@ It is primarily for me, but if you find it useful, that's great!

```sh
# Clone the template locally
git clone [email protected]:sebkolind/ts-lib-starter.git ./my-project
git clone [email protected]:sebkolind/ts-lib-starter.git my-project

# Install dependencies
# Change working directory to your project
cd my-project
npm add
```

Now, you can use any of the `npm` commands:
### Configure package

Now, remember to open the `package.json` file and change the `name` to your libraries name, and the `description`
to something related to your project.

### Start building

```sh
# Devlopement
# Install dependencies
npm install

# Development
npm run dev

# Run tests
Expand Down

0 comments on commit c41dfd7

Please sign in to comment.