Merge pull request #32 from ildecimo/develop

main -> dev

LICENSE.md

@@ -1,14 +1,21 @@
-Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved 
+MIT License
 
-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:
+Copyright (c) 2023 ildecimo
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the 
-Software.
+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 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.
+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 +1,36 @@
-# ildecimo Review Pulse - BigCommerce x Google Hackathon
+<p align="center">
+  <img alt="Review Pulse" src="public/images/logo.webp" width="100">
+</p>
+
+<h1 align="center">ildecimo: Review Pulse <br />BigCommerce x Google BigAI Hackathon</h1>
+
+**Table of contents**
+
+1. [Introduction](#introduction)
+1. [Development](#development)
+1. [License](#license)
+
+---
+
+## Introduction
+
+**Review Pulse** is a single-click BigCommerce app to help you organize, understand, and respond to customer feedback.
+
+[🖥 Landing page](https://reviewpulse.ildecimo.com/)
+
+[🖥 Production app](https://big-ai-eight.vercel.app/)
+
+[▶️ Walk-through video](https://www.youtube.com/watch?v=qG-rhnudhaw)
+
+## Development
+
+For working on the application we have the following scripts:
+
+- `npm install`: Install the NPM dependencies.
+- `npm run dev`: Start the development server.
+- `npm run ngrok`: Start the Ngrok tunnel, this points the local environment to the URL used in the `[dev]` BigCommerce app.
+
+## License
+
+Released under the [MIT](LICENSE.md) license.<br>
+Authored and maintained by [**ildecimo**](https://www.ildecimo.com/).