Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ricardojrmcom committed Dec 13, 2021
1 parent 4d91c69 commit 1474217
Showing 1 changed file with 4 additions and 52 deletions.
56 changes: 4 additions & 52 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,57 +21,6 @@

<br />

### <b>Bootstrap</b>

```ts
npx @ricardo-jrm/use-number-format
```

Boilerplate `React` project bootstrapped with all necessary configs and workflows

<br />

### <b>Workflows</b>

Quality Assurance

- Will lint code and run tests
- Runs on `pull_request` sync and `push` to `main`

Release

- Will create a GitHub release with auto generated versioning and changelog
- Will publish the package to the public NPM registry
- Runs on `push` to `main` and after the QA job

Publish to GitHub (Public)

- Will publish the package to the public GitHub registry
- Runs on `workflow_dispatch`

<br />

### <b>Dev Dependencies</b>

- `React`
- `Typescript`
- `Prettier`
- `ESLint`
- `Commit Lint`
- `Lint Staged`
- `Husky`
- `Jest`
- `React Testing Library`
- `Storybook`
- `Webpack`
- `Semantic Release`

<br />

---

<br />

### <b>Install</b>

```ts
Expand All @@ -85,7 +34,10 @@ yarn add @ricardo-jrm/use-number-format
### <b>Usage</b>

```ts
import { ExampleComponent, useExampleHook } from '@ricardo-jrm/use-number-format';
import { useNumberformat } from '@ricardo-jrm/use-number-format';

useNumberFormat(1337)
-> "1,337"
```

<br />
Expand Down

0 comments on commit 1474217

Please sign in to comment.