From 92c8e3d561eadc94014659e98d8d3363f1f6996a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Kacper=20W=C5=82odarczyk?= <kacperwlodarczyk@protonmail.com>
Date: Sun, 17 Sep 2023 16:25:52 +0200
Subject: [PATCH] Update docs for 1.0 version

---
 docs/changelogs.md | 51 +++++++++++++++++++++++++++++++++++++++++++++-
 docs/commands.md   | 24 ++++++++++++++++++++++
 2 files changed, 74 insertions(+), 1 deletion(-)

diff --git a/docs/changelogs.md b/docs/changelogs.md
index 12634d5..b77aafe 100644
--- a/docs/changelogs.md
+++ b/docs/changelogs.md
@@ -1,10 +1,59 @@
 # Change log
 
 
-## Current version: 0.9
+## Current version: 1.0
 
 ## Version history
 
+### 1.0
+- Delete command to run web application without docker 
+- Post classification using transformers to check if post content is possitive or negative and save those data to database
+
+```bash
+python post-classifier <option>
+
+Options:
+--all-posts // Run post classification for all posts from the database
+--id // Run post classification for specified post from the database
+--person-id // Run post classification for a specified person from the database
+```
+
+- Add missing typehints 
+- Change the structure of a project 
+- Friend crawler (This command works similarly to the command that scrapes data about a given user's friends list. The difference, however, is that after scraping and creating Friend objects, it also creates objects for the CrawlerQueue model and after successfully scraping friends for one user, it proceeds to scraping the list of friends for the next user in the queue.)
+
+#### Run crawler
+Start crawler for specified facebook account 
+```bash
+python main.py friend-crawler <facebook_id>
+```
+
+#### Display queue
+Display all objects available in the queue
+```bash
+python main.py display-queue
+```
+
+#### Delete queue object
+Delete specified queue object 
+```bash
+python main.py delete-queue-object <id>
+```
+
+#### Clear queue
+Delete all objects from the queue 
+```bash
+python main.py clear-queue
+```
+
+- Option to scrape multiply users in full-scrape command 
+
+```bash
+python main.py full-scrape <facebook_id> <facebook_id> <facebook_id>
+
+
+```
+
 ### 0.9
 - Add repository functions to return all data for specified Person object
 - Implement LangChain and free Open Source LLM model to create summary for specified Person object based on scraped data
diff --git a/docs/commands.md b/docs/commands.md
index cc3c5fd..e80f3b9 100644
--- a/docs/commands.md
+++ b/docs/commands.md
@@ -206,4 +206,28 @@ python main.py delete-queue-object <id>
 Delete all objects from the queue 
 ```bash
 python main.py clear-queue
+```
+
+
+## Post classification using transformer 
+
+### Display Posts in CLI application
+```bash
+python main.py posts <option>
+
+Options:
+--display-all  // Display all posts from the database
+--id // Display a specified post from the database
+--person-id //  Display posts for a specified person from the database
+
+```
+
+### Run posts classfication 
+```bash
+python post-classifier <option>
+
+Options:
+--all-posts // Run post classification for all posts from the database
+--id // Run post classification for specified post from the database
+--person-id // Run post classification for a specified person from the database
 ```
\ No newline at end of file