From 31d347cdfef1c547dd4a499cdfeb201d329d58e9 Mon Sep 17 00:00:00 2001 From: Brad Adams Date: Wed, 16 Aug 2023 17:28:53 +0200 Subject: [PATCH 1/7] docs: update README --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 50080ae..ddd86d8 100644 --- a/README.md +++ b/README.md @@ -1 +1,25 @@ -# ildecimo Review Pulse - BigCommerce x Google Hackathon \ No newline at end of file +

+ Review Pulse +

+ +

ildecimo: Review Pulse
BigCommerce x Google BigAI Hackathon

+ +## Introduction + +[Review Pulse](https://reviewpulse.ildecimo.com/) is a one-click BigCommerce app that helps you organize, understand, and respond to customer feedback. + +[▶️ Watch 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 + +Authored and maintained by the **ildecimo** team. + +> [ildecimo.com](https://www.ildecimo.com/) · [Twitter](https://twitter.com/ildecimo_web3) · [LinkedIn](https://www.linkedin.com/company/ildecimo) From 3fe64f30ff778cab9cea90e9d0af5ed5a78e9260 Mon Sep 17 00:00:00 2001 From: Brad Adams Date: Wed, 16 Aug 2023 17:31:39 +0200 Subject: [PATCH 2/7] docs: fix alignment --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ddd86d8..53b7743 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -

+

Review Pulse

-

ildecimo: Review Pulse
BigCommerce x Google BigAI Hackathon

+

ildecimo: Review Pulse
BigCommerce x Google BigAI Hackathon

## Introduction From baaad877c283bcef3995439775d12469946f1064 Mon Sep 17 00:00:00 2001 From: Brad Adams Date: Wed, 16 Aug 2023 17:37:43 +0200 Subject: [PATCH 3/7] docs: update README links --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 53b7743..9c3cf08 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,4 @@ For working on the application we have the following scripts: ## License -Authored and maintained by the **ildecimo** team. - -> [ildecimo.com](https://www.ildecimo.com/) · [Twitter](https://twitter.com/ildecimo_web3) · [LinkedIn](https://www.linkedin.com/company/ildecimo) +Authored and maintained by [**ildecimo**](https://www.ildecimo.com/). From 94ae804393d938117095498542be914374c1c602 Mon Sep 17 00:00:00 2001 From: Brad Adams Date: Wed, 16 Aug 2023 17:40:18 +0200 Subject: [PATCH 4/7] docs: add TOC + Add table of contents to README --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 9c3cf08..f4084f5 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,14 @@

ildecimo: Review Pulse
BigCommerce x Google BigAI Hackathon

+**Table of contents** + +1. [Introduction](#introduction) +1. [Development](#development) +1. [License](#license) + +--- + ## Introduction [Review Pulse](https://reviewpulse.ildecimo.com/) is a one-click BigCommerce app that helps you organize, understand, and respond to customer feedback. From 5ad320e61b3bda0cca891b99f604aa96a029a7a0 Mon Sep 17 00:00:00 2001 From: Brad Adams Date: Wed, 16 Aug 2023 17:42:22 +0200 Subject: [PATCH 5/7] docs: adjust README introduction --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f4084f5..5b825fc 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ ## Introduction -[Review Pulse](https://reviewpulse.ildecimo.com/) is a one-click BigCommerce app that helps you organize, understand, and respond to customer feedback. +[Review Pulse](https://reviewpulse.ildecimo.com/) is a single-click BigCommerce app to help you organize, understand, and respond to customer feedback. [▶️ Watch walk-through video](https://www.youtube.com/watch?v=qG-rhnudhaw) From 00640a07bbce912f246f25a7b7a61e7cf9a37b02 Mon Sep 17 00:00:00 2001 From: Brad Adams Date: Wed, 16 Aug 2023 17:46:26 +0200 Subject: [PATCH 6/7] chore: update license --- LICENSE.md | 29 ++++++++++++++++++----------- README.md | 1 + 2 files changed, 19 insertions(+), 11 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index 43ff07c..7c29546 100644 --- a/LICENSE.md +++ b/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. \ No newline at end of file +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. diff --git a/README.md b/README.md index 5b825fc..828d507 100644 --- a/README.md +++ b/README.md @@ -28,4 +28,5 @@ For working on the application we have the following scripts: ## License +Released under the [MIT](LICENSE.md) license.
Authored and maintained by [**ildecimo**](https://www.ildecimo.com/). From 88924f8b63f5297d186f4ab8689488ce40355546 Mon Sep 17 00:00:00 2001 From: Brad Adams Date: Wed, 16 Aug 2023 17:54:04 +0200 Subject: [PATCH 7/7] docs: README improvements --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 828d507..4ab8f4b 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,13 @@ ## Introduction -[Review Pulse](https://reviewpulse.ildecimo.com/) is a single-click BigCommerce app to help you organize, understand, and respond to customer feedback. +**Review Pulse** is a single-click BigCommerce app to help you organize, understand, and respond to customer feedback. -[▶️ Watch walk-through video](https://www.youtube.com/watch?v=qG-rhnudhaw) +[🖥 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