Udpate readme

Author: imranhsayed

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Imran Sayed
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,30 +1,70 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+## 🎨 Next.js WooCommerce REST API
+[![Project Status: Active.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
+![Stars](https://img.shields.io/github/stars/imranhsayed/nextjs-woocommerce-restapi?label=%E2%AD%90%20Stars)
+![Forks](https://img.shields.io/github/forks/imranhsayed/nextjs-woocommerce-restapi?color=%23ff69b4)
+![Contributors](https://img.shields.io/github/contributors/imranhsayed/nextjs-woocommerce-restapi?color=blue)
+![Follow](https://img.shields.io/github/followers/imranhsayed?label=Please%20follow%20%20to%20support%20my%20work%20%F0%9F%99%8F&style=social)
 
-## Getting Started
+- React WooCommerce Theme, using Decoupled Architecture in Next.js
+- Backend in WordPress
+- Front end in React.
+- Data is Fetched through REST API.
 
-First, run the development server:
+## Features
+1. Home Page, Blog Page, Post Page
+2. Post Preview ( Coming Soon )
+3. Product Pagination ( Coming Soon )
+4. Load More Products ( Coming Soon )
+8. REST API endpoints.
+9. Header and Footer in Next.js fetching from WordPress Menu items.
+10. WordPress Widgets displayed on Next.js frontend.
+11. Site title, tagline, copyright text, social links sourced from WordPress.
+12. Next.js Image component, that has image optimization at request time ( Coming Soon )
+13. Authentication with JWT and Http Only Cookie implementation. ( Coming Soon )
+14. Login feature for WP Post Preview in Next.js ( Coming Soon )
+15. Incremental Static (Re)generation and automatic creation of New Static post pages
+    without having to re-build next.js the application. ( Coming Soon )
+14. Gutenberg styles support ( Coming Soon )
+
+## [Tutorial Course](https://www.youtube.com/playlist?list=PLD8nQCAhR3tSRwsvzRtogv9MFkEWo5d9c)
+
+## [Live Demo Link](#)
+Coming Soon.
+
+## Setup
+
+First clone/fork the repo and cd into it.
 
 ```bash
+git clone https://github.com/imranhsayed/nextjs-woocommerce-restapi.git
+cd nextjs-woocommerce-restapi
+npm install
 npm run dev
-# or
-yarn dev
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+## Add Headless features for WordPress
+
+- Install and Activate following WordPress Plugins:
+
+* [headless-cms](https://github.com/imranhsayed/headless-cms)
+* [woocommerce](https://wordpress.org/plugins/woocommerce/)
+
+## Configuration :wrench:
 
-You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
+1. (Required) Create a `.env` file taking reference from `.env-example` and update your WordPressSite URL.
+- `NEXT_PUBLIC_WORDPRESS_URL=https://example.com`
 
-## Learn More
+2. In your WordPress Dashboard, Go to Settings > General > Site Address (URL) ( Set this to Frontend URL e.g. http://localhost:3000 during development )
+3. Create the Header and Footer Menus In WordPress Dashboard and set them to HCMS Header menu and HCMS Footer Menu respectively.
 
-To learn more about Next.js, take a look at the following resources:
+## Versioning :bookmark_tabs:
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+I use [Git](https://github.com/) for versioning.
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+## Author :bust_in_silhouette:
 
-## Deploy on Vercel
+* **[Imran Sayed](https://twitter.com/imranhsayed)**
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/import?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+## License :page_with_curl:
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details