Update README and LICENSE

.github/workflows/paradrop.yml

@@ -13,30 +13,32 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+
+      - name: Set Up Golang
+        uses: actions/setup-go@v5
         with:
-          fetch-depth: 0
-
-      - name: Set up Python 3.10
-        uses: actions/setup-python@v4
+          go-version: ">=1.22.3"
+
+      - name: Build paradrop-agent Binary
+        run: cd agent && make lint && make
+
+      - name: Set Up Python 3.12
+        uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
+          python-version: "3.12"
 
       - name: Install Python Dependencies
-        run: |
-          make pip
+        run: make pip
 
       - name: Run Linters
-        run: |
-          make lint
+        run: make lint
 
       - name: Provision Paradrop Stack with Seed Data
-        run: |
-          make local
+        run: make local
 
       - name: Test with Python unittest
-        run: |
-          make pytest
+        run: make pytest
 
       - name: Run Vulnerability Scanner On paradrop-api Image
         uses: aquasecurity/trivy-action@master

README.md

@@ -1,63 +1,103 @@
 <p align="center">
-    <img width="214" height="42" src="./ui/static/assets/logo-red.png">
+    <img width="214" height="42" src="./ui/static/assets/logo-red.png" alt="paradrop">
 </p>
 
-<h3 align="center">Simple, Easy Infrastructure Scanning</h3>
+<h2 align="center">Cybersecurity Asset Management</h2>
 
----
+[![Demo][demo_url_img]][demo_url]
+[![Admin Docs][admin_doc_img]][admin_doc_url]
+[![API Docs][api_doc_img]][api_doc_url]
+[![License][repo_license_img]][repo_license_url]
 
-## Provision Elasticsearch and Kibana Docker Containers With Seed Data
+paradrop is an open source, cybersecurity asset management tool that collects operating system information, including configurations, security settings, resource metrics, and installed and running software. The paradrop UI provides accessible, searchable, and filterable views on the data the paradrop agent collects from supported platforms. Our end goal is to build an easily customizable solution that provides methods to automate United States Government challenges around System Security Plans (SSP), Authorization to Operate (ATO), and Software Bill of Materials (SBOMs).
 
-From your local terminal in the paradrop directory:
+## ⚡️ Quick start
 
-```sh
-cd elk
-sudo ./seed.sh
+> 🐳  **Docker Compose** Method  
+> First install NodeJS 18.x, Make, cURL and Docker
+
+```bash
+make local
 ```
 
-## Access Elasticsearch and Kibana
+> 🖥️  **Vagrant** Method
+
+```bash
+vagrant up
+```
+
+Go to https://localhost:8443/ui/
+
+## 📖 Docs
 
-Kibana - open your browser to <http://localhost:5601/>
+**Main Docs**: https://demo.paradrop.io/docs
 
-Username: `admin`
+**Swagger API Docs**: https://demo.paradrop.io/apidocs/
 
-Password: `dtYe2cKY2YtyBEJ49a`
+## ⚙️ Development
 
-The same username and password is used to access Elasticsearch.
+### `Opensearch`
 
-Example GET request:
+> 🔔 Requires cURL, Make and Docker
 
-```sh
-curl -k -u 'admin:dtYe2cKY2YtyBEJ49a' -H 'Content-Type: application/json' 'https://localhost:9200/'
+```bash
+make elk
 ```
 
-## Lint Code
+### `api`
 
-From your local terminal in the paradrop directory:
+> 🔔 Requires Python >=3.10.
 
-```sh
-./lint.sh
+```bash
+make api
 ```
 
-## Build API Docker Container
+### `ui`
 
-From your local terminal in the paradrop directory:
+> 🔔 Requires Python 3.x or serve static assets from build UI directory.
 
-```sh
-sudo ./start.sh
+```bash
+make ui
 ```
 
-## Build UI Docker Container
+### `agent`
 
-From your local terminal in the paradrop directory:
+> 🔔 Requires Go >=1.22 
 
-```sh
-cd ui
-sudo ./start.sh
+```bash
+cd agent
+make
 ```
 
-## Default Username and Password In paradrop_users Index
 
-Username/Email: `[email protected]`
+## 🚧 Project Status
+
+The paradrop tool is early in development, and we're still building more documentation to help you deploy across different architectures, accelerate iterating on changes, and enhance security controls this year.
+
+We hope you star this project, engage with us, and check back when you can for further updates coming soon.
+
+
+## ⚠️ License
+
+[`paradrop`][repo_url] is free and open source software licensed under 
+the [GNU General Public License v3.0][repo_license_url]
+
+
+<!-- Links -->
+[admin_doc_url]: https://demo.paradrop.io/docs
+
+[repo_license_url]: https://github.com/Metrostar/paradrop/blob/main/COPYING
+
+[repo_url]: https://github.com/MetroStar/paradrop
+
+[repo_license_img]: https://img.shields.io/badge/license-GPLv3-purple?style=for-the-badge&logo=none
+
+[admin_doc_img]: https://img.shields.io/badge/admin_docs-click_here-blue?style=for-the-badge&logo=none
+
+[api_doc_img]: https://img.shields.io/badge/api_docs-click_here-pink?style=for-the-badge&logo=none
+
+[api_doc_url]: https://demo.paradrop.io/apidocs/
+
+[demo_url]: https://demo.paradrop.io/ui/login/
 
-Password: `Paradrop789!`
+[demo_url_img]: https://img.shields.io/badge/demo-click_here-red?style=for-the-badge&logo=none