fix: modify readme
This commit is contained in:
parent
ce5bd1a879
commit
e33eb8df3b
|
|
@ -18,31 +18,21 @@
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## Getting Started
|
## Development
|
||||||
|
|
||||||
Run this command and follow the prompts:
|
Run this command and follow the prompts
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npx create-maizzle
|
npm install
|
||||||
|
|
||||||
|
npm run dev
|
||||||
```
|
```
|
||||||
|
|
||||||
## Documentation
|
## Build
|
||||||
|
|
||||||
Maizzle documentation is available at https://maizzle.com
|
Run this command to build the project to generate the final output in the assets/mailer_templates/build_production
|
||||||
|
folder
|
||||||
|
|
||||||
## Issues
|
```bash
|
||||||
|
npm run build
|
||||||
Please open all issues in the [framework repository](https://github.com/maizzle/framework).
|
```
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
The Maizzle framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
|
|
||||||
|
|
||||||
[npm]: https://www.npmjs.com/package/@maizzle/framework
|
|
||||||
[npm-stats]: https://npm-stat.com/charts.html?package=%40maizzle%2Fframework&from=2019-03-27
|
|
||||||
[npm-version-shield]: https://img.shields.io/npm/v/@maizzle/framework.svg
|
|
||||||
[npm-stats-shield]: https://img.shields.io/npm/dt/@maizzle/framework.svg?color=6875f5
|
|
||||||
[github-ci]: https://github.com/maizzle/framework/actions
|
|
||||||
[github-ci-shield]: https://github.com/maizzle/framework/actions/workflows/nodejs.yml/badge.svg
|
|
||||||
[license]: ./LICENSE
|
|
||||||
[license-shield]: https://img.shields.io/npm/l/@maizzle/framework.svg?color=0e9f6e
|
|
||||||
Loading…
Reference in New Issue