Skip to content

Commit

Permalink
📝 docs(README/LICENSE): adding readme and license
Browse files Browse the repository at this point in the history
  • Loading branch information
Angel Martinez committed Oct 15, 2020
1 parent 85835f2 commit 56192c6
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 2 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) Angel Martinez <angel.codes139@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# cra-template-tailwindcss-starter

This is a create-react-app template for create a react project with tailwindcss already configured.

## Usage

To use this template, you should run the following command in your terminal / cmd.

```sh
npx create-react-app your-app-name --template tailwindcss-starter
```

## Extra
- You can completely edit the `tailwind.config.js` file to add your custom values
- To generate the tailwindcss development file you must run the following command:
```sh
yarn build-css:develop
```
- This template includes a plugin to organize the classes in your files with the help of prettier. You only need to run:
```sh
yarn format
```

## This project use

All the important library's that the project use.

- create-react-app
- tailwindcss
- prettier / prettier-plugin-tailwind

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.


[MIT LICENSE](LICENSE) - Angel Martinez
4 changes: 2 additions & 2 deletions template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ In the project directory, you can run:

### `yarn build-css:develop`

Will generate a file called styles.css, which is the complete build of tailwindcss.
Will generate a file called `styles.css`, which is the complete build of tailwindcss.

### `yarn build-css:production`

Will generate a file called styles.css, which is the purged build of tailwindcss.
Will generate a file called `styles.css`, which is the purged build of tailwindcss.

### `yarn format`

Expand Down

0 comments on commit 56192c6

Please sign in to comment.