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 ddda3f5
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 7 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,25 @@ 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

Open the `package.json` file and change the `name`, `description` and `author` fields to something you'd like.
The `name` should be unique and you should use a namespace (like how I use `@sebkolind` for my packages),
`author` is you and `description` is a short summary of what your package is about.

### Start building

```sh
# Devlopement
# Install dependencies
npm install

# Development
npm run dev

# Run tests
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{
"name": "@sebkolind/ts-lib-starter",
"version": "0.0.1",
"name": "@sebkolind/ts-lib-starter",
"description": "A TypeScript library starter template",
"author": "sebkolind <[email protected]>",
"source": "lib/main.ts",
"module": "dist/main.js",
"type": "module",
Expand All @@ -20,7 +21,6 @@
"library",
"parcel"
],
"author": "sebkolind <[email protected]>",
"license": "MIT",
"devDependencies": {
"@parcel/packager-ts": "^2.12.0",
Expand Down

0 comments on commit ddda3f5

Please sign in to comment.