mikeconrad/blog
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add features to README.md

Browse Source
This commit is contained in:
prototypa
2022-08-10 16:55:25 -04:00
parent 3fc9b32d66
commit 1cd0ab833d
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -4,6 +4,20 @@ A template to make your website using Astro + Tailwind CSS.
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! > 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
<br>
## 🚀 Features
- Excellent integration with Tailwind CSS via [@astrojs/tailwind](https://docs.astro.build/en/guides/integrations-guide/tailwind/)
- Image optimization using [@astrojs/images](https://docs.astro.build/en/guides/integrations-guide/image/)
- Automatically generate the project sitemap with [@astrojs/sitemap](https://docs.astro.build/en/guides/integrations-guide/sitemap/)
- Optimize the use of fonts from Google Fonts in post build using [subfont](https://www.npmjs.com/package/subfont) npm package
- Excellent score in Google Chrome Lighthouse report (build code): **100 Performance**, **100 Accessibility**, **100 Best Practices**, **100 SEO**
- Production ready PageSpeed Insights: [Test pagespeed for Astrowind Demo](https://pagespeed.web.dev/report?url=https%3A%2F%2Fastrowind.vercel.app%2F)
<br>
## 🚀 Project Structure ## 🚀 Project Structure
Inside AstroWind template, you'll see the following folders and files: Inside AstroWind template, you'll see the following folders and files:
@ -35,6 +49,8 @@ There's nothing special about `src/components/`, but that's where we like to put
Any static assets, like images, can be placed in the `public/` directory. Any static assets, like images, can be placed in the `public/` directory.
<br>
## 🧞 Commands ## 🧞 Commands
All commands are run from the root of the project, from a terminal: All commands are run from the root of the project, from a terminal:
@ -46,6 +62,8 @@ All commands are run from the root of the project, from a terminal:
| `npm run build` | Build your production site to `./dist/` | | `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying | | `npm run preview` | Preview your build locally, before deploying |
<br>
## 👀 Want to learn more? ## 👀 Want to learn more?
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).