Skip to content

Commit b1948ca

Browse files
authored
Merge pull request #597 from FalkorDB/readme-formatting-improvements
docs: improve README formatting and add support sections
2 parents f444837 + 63cb8dc commit b1948ca

1 file changed

Lines changed: 17 additions & 10 deletions

File tree

README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
1+
<div align="center">
2+
13
# CodeGraph - Knowledge Graph Visualization Tool
24

3-
### Visualize your repository with our graph for code analysis
5+
**Visualize codebases as knowledge graphs to analyze dependencies, detect bottlenecks, and optimize projects.**
6+
7+
Connect and ask questions: [![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?&logo=discord&logoColor=white)](https://discord.gg/b32KEzMzce)
48

59
[![Try Free](https://img.shields.io/badge/Try%20Free-FalkorDB%20Cloud-FF8101?labelColor=FDE900&link=https://app.falkordb.cloud)](https://app.falkordb.cloud)
610
[![Dockerhub](https://img.shields.io/docker/pulls/falkordb/falkordb?label=Docker)](https://hub.docker.com/r/falkordb/falkordb/)
7-
[![Discord](https://img.shields.io/discord/1146782921294884966?style=flat-square)](https://discord.com/invite/6M4QwDXn2w)
811

912
![Alt Text](https://res.cloudinary.com/dhd0k02an/image/upload/v1739719361/FalkorDB_-_Github_-_readme_jr6scy.gif)
1013

1114
**[Live Demo](https://code-graph.falkordb.com/)**
1215

16+
</div>
17+
1318
## Project Structure
1419

1520
```
@@ -72,6 +77,13 @@ Copy the template and configure:
7277
cp .env.template .env
7378
```
7479

80+
| Variable | Description | Required | Default |
81+
|----------|-------------|----------|---------|
82+
| `OPENAI_API_KEY` | Your OpenAI API key for code analysis | Yes | - |
83+
| `SECRET_TOKEN` | User-defined token for request authorization | Yes | - |
84+
| `FALKORDB_HOST` | FalkorDB server hostname | No | localhost |
85+
| `FALKORDB_PORT` | FalkorDB server port | No | 6379 |
86+
7587
Edit `.env` with your values:
7688

7789
```bash
@@ -204,13 +216,8 @@ Support for additional languages is planned.
204216
| POST | `/list_commits` | List commits of a repository |
205217
| POST | `/switch_commit` | Switch to a specific commit |
206218

207-
## Community
208-
209-
Have questions or feedback? Reach out via:
210-
211-
* [GitHub Issues](https://github.com/FalkorDB/code-graph/issues)
212-
* Join our [Discord](https://discord.com/invite/6M4QwDXn2w)
219+
## License
213220

214-
If you find this repository helpful, please consider giving it a star!
221+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
215222

216-
Knowledge Graph, Code Analysis, Code Visualization, Dead Code Analysis, Graph Database
223+
Copyright FalkorDB Ltd. 2025

0 commit comments

Comments
 (0)