📘 DOCS - Update

IndexOffy · Feb 25, 2023 · 4b03580 · 4b03580
1 parent ca94dda
commit 4b03580
Show file tree

Hide file tree

Showing 3 changed files with 59 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -2,11 +2,10 @@
 
 ![GitHub Org's stars](https://img.shields.io/github/stars/IndexOffy?label=IndexOffy&style=flat-square)
 ![GitHub last commit](https://img.shields.io/github/last-commit/IndexOffy/onion-network-dataset?style=flat-square)
-![GitHub Pipenv locked Python version](https://img.shields.io/github/pipenv/locked/python-version/IndexOffy/onion-network-dataset?style=flat-square)
 
 ## Introduction
 
-Graph and dataset of connections between anion websites.
+Database of onion network sites and graphs related to connections.
 
 ## Project objectives:
 
@@ -22,6 +21,7 @@ Graph and dataset of connections between anion websites.
 - Download Connections - [_connection.csv](#)
 
 ### Commit Style
+
 - ⚙️ NO-TASK
 - 📝 PEP8
 - 📌 ISSUE
@@ -31,6 +31,13 @@ Graph and dataset of connections between anion websites.
 - ❤️️ TEST
 - ⚠️ SECURITY
 
+### License
+
+![GitHub](https://img.shields.io/github/license/IndexOffy/onion-network-dataset?style=flat-square)
+
+This project is licensed under the terms of the MIT license.
+
 **RESOURCES**
+
 - GitHub: [https://github.com/IndexOffy/onion-network-dataset](https://github.com/IndexOffy/onion-network-dataset)
 - Docs:   [http://www.indexoffy.com/](http://www.indexoffy.com/)
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,41 @@
+![GitHub Org's stars](https://img.shields.io/github/stars/IndexOffy?label=IndexOffy&style=flat-square)
+![GitHub last commit](https://img.shields.io/github/last-commit/IndexOffy/onion-network-dataset?style=flat-square)
+
+## Introduction
+
+Database of onion network sites and graphs related to connections.
+
+## Project objectives:
+
+- Answer the question of how many sites are possible to discover through scraping.
+- Graph relationships between onion network sites.
+- Provide a complete list of discovered sites.
+- Apply machine learning techniques to categorize websites based on content.
+- Apply ranking techniques to provide a search engine.
+
+### Initial dataset
+
+- Download Links - [_link.csv](#)
+- Download Connections - [_connection.csv](#)
+
+### Commit Style
+
+- ⚙️ NO-TASK
+- 📝 PEP8
+- 📌 ISSUE
+- 🪲 BUG
+- 📘 DOCS
+- 📦 BUILD
+- ❤️️ TEST
+- ⚠️ SECURITY
+
+### License
+
+![GitHub](https://img.shields.io/github/license/IndexOffy/onion-network-dataset?style=flat-square)
+
+This project is licensed under the terms of the MIT license.
+
+**RESOURCES**
+
+- GitHub: [https://github.com/IndexOffy/onion-network-dataset](https://github.com/IndexOffy/onion-network-dataset)
+- Docs:   [http://www.indexoffy.com/](http://www.indexoffy.com/)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,9 @@
+site_name: Onion Network Dataset
+repo_url: https://github.com/IndexOffy/onion-network-dataset
+copyright: IndexOffy
+
+nav:
+    - onion-network-dataset: index.md
+
+theme: 
+    name: simple-blog