updated readme

Author: swilly22

README.md

@@ -5,25 +5,43 @@
 ## Getting Started
 [Live Demo](https://code-graph.falkordb.com/)
 
+## Running locally
 
+### Run FalkorDB
+Free cloud instance: http://cloud.falkordb.com/
+Or by running locally with docker:
 ```bash
-flask --app code_graph run --debug
+docker run -p 6379:6379 -p 3000:3000 -it --rm falkordb/falkordb:latest
 ```
 
-Process local git repository, ignoring specific folder(s)
+### Config
+Create your own `.env` file from the `.env.template` file
 
+Start the server:
 ```bash
-curl -X POST http://127.0.0.1:5000/process_local_repo -H "Content-Type: application/json" -d '{"repo": "/Users/roilipman/Dev/FalkorDB", "ignore": ["./.github", "./sbin", "./.git","./deps", "./bin", "./build"]}'
+flask --app api/index.py run --debug
 ```
 
-Process code coverage
-
+### Creating a graph
+Process a local source folder:
 ```bash
-curl -X POST http://127.0.0.1:5000/process_code_coverage -H "Content-Type: application/json" -d '{"lcov": "/Users/roilipman/Dev/code_graph/code_graph/code_coverage/lcov/falkordb.lcov", "repo": "FalkorDB"}'
+curl -X POST http://127.0.0.1:5000/analyze_folder -H "Content-Type: application/json" -d '{"path": "<FULL_PATH_TO_FOLDER>", "ignore": [<OPTIONAL_IGNORE_LIST>]}' -H "Authorization: <.ENV_SECRET_TOKEN>"
 ```
 
-Process git information
-
+For example:
 ```bash
-curl -X POST http://127.0.0.1:5000/process_git_history -H "Content-Type: application/json" -d '{"repo": "/Users/roilipman/Dev/falkorDB"}'
+curl -X POST http://127.0.0.1:5000/analyze_folder -H "Content-Type: application/json" -d '{"path": "/Users/roilipman/Dev/GraphRAG-SDK", "ignore": ["./.github", "./build"]}' -H "Authorization: OpenSesame"
 ```
+## Working with your graph
+Once the source code analysis completes your FalkorDB DB will be populated with
+a graph representation of your source code, the graph name should be the same as
+the name of the folder you've requested to analyze, for the example above a graph named:
+"GraphRAG-SDK".
+
+At the moment only the Python and C languages are supported, we do intend to support additional languages.
+
+At this point you can explore and query your source code using various tools
+Here are several options:
+1. FalkorDB built-in UI
+2. One of FalkorDB's clients[https://docs.falkordb.com/clients.html]
+3. Use FalkorDB GraphRAG-SDK[https://github.com/FalkorDB/GraphRAG-SDK] to connect an LLM for natural language exploration.