From 4e3eb9ce3af4d2d46f875d194b21fb211fc72cb6 Mon Sep 17 00:00:00 2001 From: prototypa Date: Sat, 27 Aug 2022 03:18:15 -0400 Subject: [PATCH] Update README.md --- README.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 51 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 01b6c91..6a8efc0 100644 --- a/README.md +++ b/README.md @@ -20,11 +20,36 @@ AstroWind Theme Screenshot -[Live demo](https://astrowind.vercel.app/) +
+ +
+Table of Contents + +- [Demo](#demo) +- [Getting started](#getting-started) + - [Project structure](#project-structure) + - [Commands](#commands) + - [Deploy](#deploy) +- [Roadmap](#roadmap) +- [Frequently Asked Questions](#frequently-asked-questions) +- [Contributing](#contributing) +- [Acknowledgements](#acknowledgements) +- [License](#license) + +

-## Project Structure +## Demo + +[🏠 astrowind.vercel.app](https://astrowind.vercel.app/) + +
+ + +## Getting started + +### Project structure Inside AstroWind template, you'll see the following folders and files: @@ -76,7 +101,7 @@ Any static assets, like images, can be placed in the `public/` directory if they
-## Commands +### Commands All commands are run from the root of the project, from a terminal: @@ -89,9 +114,9 @@ All commands are run from the root of the project, from a terminal:
-## Deploy +### Deploy -### Deploy to production (manual) +#### Deploy to production (manual) You can create an optimized production build with: @@ -103,13 +128,17 @@ 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 +
+ +#### 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 +
+ +#### Deploy to Vercel Clone this repository on own GitHub account and deploy to Vercel: @@ -117,7 +146,7 @@ Clone this repository on own GitHub account and deploy to Vercel:
-## Roadmap v1.0 +## Roadmap - *Project*: - **(DONE)** Reduce the complexity in the components folder and simplify the other folders to make it very easy to use. @@ -140,6 +169,15 @@ Clone this repository on own GitHub account and deploy to Vercel: - *More Examples*: Add commonly used example pages (Ex: About, Terms, Services...) - *Documentation*: Create detailed documentation with best practices and redesign tips +
+ +## Frequently Asked Questions + +- +- +- + +
## Contributing @@ -147,6 +185,10 @@ Clone this repository on own GitHub account and deploy to Vercel: 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. +## Acknowledgements + +Initially created by [onWidget](https://onwidget.com) and maintained by a community of [contributors](https://github.com/onwidget/astrowind/graphs/contributors). + ## License -**AstroWind** is licensed under the MIT license — see the [LICENSE](https://github.com/onwidget/astrowind/blob/main/LICENSE) file for details. +**AstroWind** is licensed under the MIT license — see the [LICENSE](https://github.com/onwidget/astrowind/blob/main/LICENSE.md) file for details.