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

Update README.md

Browse Source
This commit is contained in:
prototypa
2022-08-14 14:21:12 -04:00
committed by GitHub
parent f4a4200e0e
commit 068b17a557
1 changed files with 17 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -5,18 +5,18 @@
A template to make your website using **Astro + Tailwind CSS**. Ready to start a new project and designed taking into account best practices A template to make your website using **Astro + Tailwind CSS**. Ready to start a new project and designed taking into account best practices
**Features** 🚀 **Features**
- Excellent **integration with Tailwind CSS** via [@astrojs/tailwind](https://docs.astro.build/en/guides/integrations-guide/tailwind/) - 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/). Supports resizing images and encoding them to different image formats. - **Image optimization** using [@astrojs/images](https://docs.astro.build/en/guides/integrations-guide/image/). Supports resizing images and encoding them to different image formats.
- Automatically generate the project sitemap with [@astrojs/sitemap](https://docs.astro.build/en/guides/integrations-guide/sitemap/) - Automatically generate the **website sitemap** with [@astrojs/sitemap](https://docs.astro.build/en/guides/integrations-guide/sitemap/)
- Optimize the use of fonts from Google Fonts at build time with [subfont](https://www.npmjs.com/package/subfont) package - **Optimize the use of fonts** from Google Fonts at build time with [subfont](https://www.npmjs.com/package/subfont) package
- Excellent score in Chrome Lighthouse reports (build code): - **Perfect score in Lighthouse** reports (build code):
- 100 Performance - 100 Performance
- 100 Accessibility - 100 Accessibility
- 100 Best Practices - 100 Best Practices
- 100 SEO - 100 SEO
- Production ready Google PageSpeed Insights score - Production **ready PageSpeed Insights** score
<br> <br>
@ -26,7 +26,7 @@ A template to make your website using **Astro + Tailwind CSS**. Ready to start a
<br> <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:
@ -81,15 +81,18 @@ All commands are run from the root of the project, from a terminal:
<br> <br>
## ⏳ Roadmap ## 🚧 Roadmap
- **Add blog**: Support for accessible, fast and SEO friendly blog - *Config*: Move specific configurations to a specialized file
- **Documentation**: Create detailed documentation with best practices and redesign tips - *Project structure*: Reduce the complexity in the components folder and simplify the other folders to make it very easy to use.
- **More components**: Add more Tailwind components useful for most scenarios (Features, Contact, Call to Actions, Content, FAQs ...) - *SEO*: Add support to easily manage SEO meta-tags (title, description, canonical, social sharing, ...)
- **More Examples**: Add commonly used example pages (Ex: About, Terms, Services...) - *Blog*: Add support for fast, accessible, and SEO friendly blog
- *More components*: Add more Tailwind components useful for most scenarios (Features, Contact, Call to Actions, Content, FAQs ...)
- *More Examples*: Add commonly used example pages (Ex: About, Terms, Services...)
- *Documentation*: Create detailed documentation with best practices and redesign tips
<br> <br>
## 👀 Want more? ## 👀 Want more?
If you have any suggestions or find any bugs, feel free to open an issue or a pull request. If you have any suggestions or find any bugs, feel free to open an issue or create a pull request.