From 9c6a67a03b5c69e3d7b91d23ccfe32d972449929 Mon Sep 17 00:00:00 2001
From: prototypa <54446028+prototypa@users.noreply.github.com>
Date: Tue, 23 Aug 2022 21:37:36 -0400
Subject: [PATCH] Update README.md
---
README.md | 54 ++++++++++++++++++++++++++++++++++++++++++------------
1 file changed, 42 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index 42982ec..f2c7cfd 100644
--- a/README.md
+++ b/README.md
@@ -7,20 +7,20 @@ A template to make your website using **Astro + Tailwind CSS**. Ready to start a
**Features**
-- Excellent integration with **Tailwind CSS** via [@astrojs/tailwind](https://docs.astro.build/en/guides/integrations-guide/tailwind/).
-- Support for fast and **SEO friendly Blog**.
-- Automatic **RSS feed** generation with [@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.
-- Automatically generate the **project sitemap** based on your routes 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) library.
-- **Production-ready** scores in Lighthouse and PageSpeed Insights reports:
- - 100 Performance, 100 Accessibility, 100 Best Practices, 100 SEO
+- Integration with **Tailwind CSS** via [@astrojs/tailwind](https://docs.astro.build/en/guides/integrations-guide/tailwind/)
+- Support for **fast and SEO friendly Blog** with automatic **RSS feed** with [@astrojs/rss](https://docs.astro.build/en/guides/rss/).
+- **Image optimization** using [@astrojs/images](https://docs.astro.build/en/guides/integrations-guide/image/).
+- Generation of **project sitemap** based on your routes with [@astrojs/sitemap](https://docs.astro.build/en/guides/integrations-guide/sitemap/).
+- It supports **Dark mode**
+- **Open Graph tags** for social media sharing
+- **Fonts optimization** build time with [subfont](https://www.npmjs.com/package/subfont) library.
+- **Production-ready** scores in [Lighthouse](https://web.dev/measure/) and [PageSpeed Insights](https://pagespeed.web.dev/) reports
-
-[Live demo](https://astrowind.vercel.app/)
+
+[Live demo](https://astrowind.vercel.app/)
@@ -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.
+[](https://githubbox.com/onwidget/astrowind/tree/main)
+
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
@@ -88,6 +90,30 @@ All commands are run from the root of the project, from a terminal:
+## Deploy
+
+### Deploy to production (manual)
+
+You can create an optimized production build with:
+
+```shell
+npm run build
+```
+
+Now, your blog 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:
+
+[](https://app.netlify.com/start/deploy?repository=https://github.com/onwidget/astrowind)
+
+
+
## Roadmap
- *Config*: Move specific configurations to a specialized file
@@ -100,6 +126,10 @@ All commands are run from the root of the project, from a terminal:
-## 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 suggestions or find any bugs, feel free to open an issue or create a pull request.
+
+## License
+
+**AstroWind** is licensed under the MIT license — see the [LICENSE](https://github.com/onwidget/astrowind/blob/main/LICENSE) file for details.