Merge pull request #536 from nttcom/topic/add-quick-start-to-readme

Topic/add quick start to readme

README.md

@@ -10,7 +10,29 @@ Threatconnectome supports vulnerability management in industries where products
 - PSIRT-friendly UI and Web API
 - SPDX 2.3 and CycloneDX 1.6 support
 
-## Demo environment
+## :rocket: Quick Start
+
+Just clone this project and move to `threatconnectome`.
+
+```bash
+git clone https://github.com/nttcom/threatconnectome
+cd threatconnectome
+```
+
+:partying_face: Try it out!
+
+```bash
+# Note: You need docker installed and running to be able to run this script.
+./demo_start.sh
+```
+
+> To stop a running service:
+> 
+> ```bash
+> ./demo_stop.sh
+> ```
+
+## :eyes: Live demo
 
 :warning: Do not input personal information.
 

demo_start.sh

@@ -49,8 +49,11 @@ docker compose -f docker-compose-demo.yml up -d --build || exit 100;
 
 cat <<EOD | tr -d "\t"
 
-	launched Threatconnectome Demo.
-	access to http://localhost with Web browser.
+	Live demo of Threatconnectome launched.
 
-	see README.md for Demo environment (accounts and contents).
+	access here via your web browser:
+	http://localhost
+
+	see README for the demo accounts and contents:
+	https://github.com/nttcom/threatconnectome/tree/main?tab=readme-ov-file#eyes-live-demo
 EOD