Skip to content

Commit

Permalink
docs: update README.md (#252)
Browse files Browse the repository at this point in the history
  • Loading branch information
donniean authored Jul 10, 2023
1 parent 94fa9ee commit 09cda48
Showing 1 changed file with 15 additions and 20 deletions.
35 changes: 15 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,9 @@
# @donniean/configs

- [@donniean/configs](#donnieanconfigs)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Delete legacy files](#delete-legacy-files)
- [License](#license)
a configs generator

[![Version](https://img.shields.io/npm/v/@donniean/configs.svg)](https://www.npmjs.com/package/@donniean/configs) [![License: MIT](https://img.shields.io/github/license/donniean/configs)](https://github.com/donniean/configs/blob/master/LICENSE) [![CI](https://github.com/donniean/configs/actions/workflows/ci.yml/badge.svg)](https://github.com/donniean/configs/actions/workflows/ci.yml) [![Release](https://github.com/donniean/configs/actions/workflows/release.yml/badge.svg)](https://github.com/donniean/configs/actions/workflows/release.yml)

> configs generator
## Prerequisites

- node >=18.0.0
Expand All @@ -27,6 +20,14 @@ npm install -g @donniean/configs
cd project-directory
```

create `configs.config.cjs`

```sh
configs init
```

create configs

```sh
configs create
```
Expand All @@ -35,6 +36,12 @@ configs create

[default config](src/constants/configs-config.ts)

## Uninstall

```sh
npm uninstall -g @donniean/configs
```

## Delete legacy files

```sh
Expand Down Expand Up @@ -119,15 +126,3 @@ rm package-lock.json;
rm -rf node_modules/;
rm -rf **/node_modules/;
```

## License

Copyright © 2019 [Donnie An](https://github.com/donniean).

This project is [MIT](https://github.com/donniean/configs/blob/master/LICENSE)
licensed.

---

_This README was generated with ❤️
by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_

0 comments on commit 09cda48

Please sign in to comment.