Merge branch 'main' of https://github.com/onwidget/astrowind

README.md

@@ -3,18 +3,18 @@
 <img src="lighthouse-score.png" align="right"
      alt="AstroWind Lighthouse Score" width="100" height="358">
 
-A template to make your website using **Astro + Tailwind CSS**. Ready to start a new project and designed taking into account best practices.
+**AstroWind** is a free and open-source 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/).
+- ✅ Integration with **Tailwind CSS** ([@astrojs/tailwind](https://docs.astro.build/en/guides/integrations-guide/tailwind/)).
-- Support for fast and **SEO friendly Blog**.
+- ✅ Supports **Dark mode**.
-- Automatic **RSS feed** generation with [@astrojs/rss](https://docs.astro.build/en/guides/rss/).
+- ✅ **Fast and SEO friendly blog** with automatic **RSS feed** ([@astrojs/rss](https://docs.astro.build/en/guides/rss/)).
-- **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** ([@astrojs/images](https://docs.astro.build/en/guides/integrations-guide/image/)).
-- Automatically generate the **project sitemap** based on your routes with [@astrojs/sitemap](https://docs.astro.build/en/guides/integrations-guide/sitemap/).
+- ✅ Generation of **project sitemap** based on your routes ([@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) library.
+- ✅ **Open Graph tags** for social media sharing
-- **Production-ready** scores in Lighthouse and PageSpeed Insights reports:
+- ✅ **Fonts optimization** at build time ([subfont](https://www.npmjs.com/package/subfont)).
-  - 100 Performance, 100 Accessibility, 100 Best Practices, 100 SEO
+- ✅ **Production-ready** scores in [Lighthouse](https://web.dev/measure/) and [PageSpeed Insights](https://pagespeed.web.dev/) reports
 
 <br>
 
@@ -71,6 +71,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 if they do not require any transformation or in the `assets/` directory if they are imported directly.
 
+[![Edit AstroWind on CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://githubbox.com/onwidget/astrowind/tree/main)
+
 > 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
 
 <br>
@@ -88,18 +90,64 @@ All commands are run from the root of the project, from a terminal:
 
 <br>
 
-## Roadmap
+## Deploy
 
-- *Config*: Move specific configurations to a specialized file
+### Deploy to production (manual)
-- *Project structure*: ~~Reduce the complexity in the components folder and simplify the other folders to make it very easy to use.~~ (DONE! Testing)
+
-- *SEO*: ~~Add support to easily manage SEO meta-tags (title, description, canonical, social sharing, ...)~~ (DONE! Testing)
+You can create an optimized production build with:
-- *Blog*: ~~Add support for fast, accessible, and SEO friendly blog~~ (DONE! Testing)
+
-- *More components*: ~~Add more Tailwind components useful for most scenarios (Features, Contact, Call to Actions, Content, FAQs ...)~~
+```shell
+npm run build
+```
+
+Now, your website is ready to be deployed. All generated files are located at
+`dist` folder, which you can deploy the folder to any hosting service you
+prefer.
+
+### Deploy to Netlify
+
+Clone this repository on own GitHub account and deploy to Netlify:
+
+[![Netlify Deploy button](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/onwidget/astrowind)
+
+### Deploy to Vercel
+
+Clone this repository on own GitHub account and deploy to Vercel:
+
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fonwidget%2Fastrowind)
+
+<br>
+
+## Roadmap v1.0
+
+- *Project*:
+  - **(DONE)** Reduce the complexity in the components folder and simplify the other folders to make it very easy to use.
+  - Create simple and clear strategy to get template updates
+  - Move specific configurations to a specialized file
+  - Fix some bugs with prettier
+  - Make the use of images clean and intuitive
+- *SEO*:
+  - **(DONE)** Add support to easily manage SEO meta-tags (title, description, canonical, social sharing, ...)
+- *Blog*:
+  - **(DONE)** Support to Fast and SEO friendly blog
+  - Improve blog design
+  - Add support for categories and tags.
+  - Create component or utilities for latest posts
+  - Create component or utilities for related posts
+  - Add more *shortcodes* or *embed* functions to posts in Markdown: (eg video, tweet...)
+- *More widgets*:
+  - ~~Add more Tailwind components useful for most scenarios (Features, Contact, Call to Actions, Content, FAQs ...)~~
+  - Create external library or place with useful Tailwind components
 - *More Examples*: Add commonly used example pages (Ex: About, Terms, Services...)
 - *Documentation*: Create detailed documentation with best practices and redesign tips
 
 <br>
 
-## Want more?
+## Contributing
 
-If you have any suggestions or find any bugs, feel free to [open an issue](https://github.com/onwidget/astrowind/issues) or [create a pull request](https://github.com/onwidget/astrowind/pulls).
+If you have any idea, suggestions or find any bugs, feel free to open a discussion, an issue or create a pull request. 
+That would be very useful for all of us and we would be happy to listen and take action.
+
+## License
+
+**AstroWind** is licensed under the MIT license — see the [LICENSE](https://github.com/onwidget/astrowind/blob/main/LICENSE) file for details.