Skip to content

Commit

Permalink
fix(@set-app/cli): fix Readme with basic info for cli
Browse files Browse the repository at this point in the history
docs(@set-app): fix main readme
  • Loading branch information
Frankeo authored Feb 23, 2023
1 parent 08b1e99 commit ed86a0d
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 19 deletions.
22 changes: 5 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<h1 align="center">Welcome to @set-app/main 👋</h1>
<h1 align="center">Welcome to @set-app/cli 👋</h1>
<p>
<a href="https://github.com/Frankeo/set-app#readme" target="_blank">
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
Expand All @@ -11,28 +11,16 @@
</a>
</p>

> Create a react app without so much configuration going around. Configure the CI/CD also required so you can focus on coding 😉
> Create a `React` and `Console` apps without so much configuration going around. It Creates the `Github project`, `beautiful READMEs` and `CI/CD` related staff so you can **focus on coding** 😉
### 🏠 [Homepage](https://www.npmjs.com/package/@set-app/cli)
### 🏠 [Homepage](https://frankeo.github.io/set-app/)

### [Demo](https://www.npmjs.com/package/@set-app/cli)

## Install

```sh
yarn install
```
### [Tool](https://www.npmjs.com/package/@set-app/cli)

## Usage

```sh
yarn dev
```

## Run tests

```sh
yarn test
npx @set-app/cli@latest
```

## Author
Expand Down
47 changes: 45 additions & 2 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,46 @@
# set-app
<h1 align="center">Welcome to @set-app/cli 👋</h1>
<p>
<a href="https://github.com/Frankeo/set-app#readme" target="_blank">
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
</a>
<a href="https://github.com/Frankeo/set-app/graphs/commit-activity" target="_blank">
<img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
</a>
<a href="https://github.com/Frankeo/set-app/blob/main/LICENSE" target="_blank">
<img alt="License: MIT" src="https://img.shields.io/github/license/frankeo/set-app" />
</a>
</p>

Create a react app without so much configuration going around. A lighter version of Create React App with enough config for start your react application but the right amount of power to generate a production ready bundle following Software Engeniering practices
> Create a `React` and `Console` apps without so much configuration going around. It Creates the `Github project`, `beautiful READMEs` and `CI/CD` related staff so you can **focus on coding** 😉
### 🏠 [Homepage](https://frankeo.github.io/set-app/)

### [Tool](https://www.npmjs.com/package/@set-app/cli)

## Usage

```sh
npx @set-app/cli@latest
```

## Author

👤 **Francisco Moreno**

* Github: [@Frankeo](https://github.com/Frankeo)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/Frankeo/set-app/issues). You can also take a look at the [contributing guide](https://github.com/Frankeo/set-app/blob/master/CONTRIBUTING.md).

## Show your support

Give a ⭐️ if this project helped you!

## 📝 License

Copyright © 2023 [Francisco Moreno](https://github.com/Frankeo).<br />
This project is [MIT](https://github.com/Frankeo/set-app/blob/master/LICENSE) licensed.

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

0 comments on commit ed86a0d

Please sign in to comment.