Skip to content

Commit

Permalink
docs(readme): fix README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
borjapazr committed Nov 23, 2021
1 parent e1dd3ba commit 121b3e7
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 3 deletions.
1 change: 1 addition & 0 deletions .cspell.json
Expand Up @@ -7,6 +7,7 @@
"bitauth",
"bitjson",
"Borja",
"borjapazr",
"cimg",
"circleci",
"codecov",
Expand Down
3 changes: 2 additions & 1 deletion .lintstagedrc.js
Expand Up @@ -4,5 +4,6 @@ module.exports = {
'eslint --cache --color --fix',
() => 'tsc --pretty --noEmit'
],
'!*.{js,ts}': ['prettier --check --write --ignore-unknown']
'!*.{js,ts}': ['prettier --check --write --ignore-unknown'],
'{README.md,TODO.md,.github/*.md,src/**/*.ts}': ['cspell']
};
16 changes: 15 additions & 1 deletion README.md
Expand Up @@ -17,7 +17,7 @@
<a href="#ℹ️-about">ℹ️ About</a> •
<a href="#-features">📋 Features</a> •
<a href="#-contributing"> 🤝 Contributing</a> •
<a href="#-roadmap"> 🛣️ Roadmap</a> •
<a href="#-roadmap"> 🛣️ Roadmap</a> •
<a href="#-credits">🎯 Credits</a> •
<a href="#-license">🚩 License</a>

Expand All @@ -31,6 +31,20 @@ The main goal of this project is to provide a base template for the generation o

> 📣 This is an opinionated template. The architecture of the code base and the configuration of the different tools used has been based on best practices and personal preferences.
### 🚀 Quick start

- Start project in development mode:

```bash
npm run dev
```

- Start project in production mode:

```bash
npm run start
```

## 📋 Features

- Built using [Typescript](https://github.com/microsoft/TypeScript)
Expand Down
2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -34,7 +34,7 @@
"check:types": "tsc --pretty --noEmit",
"check:format": "prettier --check .",
"check:lint": "eslint . --ext .js,.ts --color",
"check:spelling": "cspell \"{README.md,.github/*.md,src/**/*.ts}\"",
"check:spelling": "cspell \"{README.md,TODO.md,.github/*.md,src/**/*.ts}\"",
"fix:format": "prettier --check --write --ignore-unknown .",
"fix:lint": "npm run check:lint -- --fix",
"check:staged": "lint-staged",
Expand Down

0 comments on commit 121b3e7

Please sign in to comment.