Skip to content

Commit db06ab7

Browse files
gkorlandclaude
andcommitted
docs: improve README formatting and add support sections
Cherry-picked from #472: - Centered header with professional layout - Environment variables reference table - Contributing, License, and Support sections Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 68cf518 commit db06ab7

1 file changed

Lines changed: 28 additions & 7 deletions

File tree

README.md

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
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.**
46

57
[![Try Free](https://img.shields.io/badge/Try%20Free-FalkorDB%20Cloud-FF8101?labelColor=FDE900&link=https://app.falkordb.cloud)](https://app.falkordb.cloud)
68
[![Dockerhub](https://img.shields.io/docker/pulls/falkordb/falkordb?label=Docker)](https://hub.docker.com/r/falkordb/falkordb/)
@@ -10,6 +12,8 @@
1012

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

15+
</div>
16+
1317
## Project Structure
1418

1519
```
@@ -72,6 +76,13 @@ Copy the template and configure:
7276
cp .env.template .env
7377
```
7478

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

7788
```bash
@@ -204,13 +215,23 @@ Support for additional languages is planned.
204215
| POST | `/list_commits` | List commits of a repository |
205216
| POST | `/switch_commit` | Switch to a specific commit |
206217

207-
## Community
218+
## Contributing
208219

209-
Have questions or feedback? Reach out via:
220+
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
210221

211-
* [GitHub Issues](https://github.com/FalkorDB/code-graph/issues)
212-
* Join our [Discord](https://discord.com/invite/6M4QwDXn2w)
222+
## License
213223

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

216-
Knowledge Graph, Code Analysis, Code Visualization, Dead Code Analysis, Graph Database
226+
## Support
227+
228+
- [GitHub Issues](https://github.com/FalkorDB/code-graph/issues)
229+
- [Discord](https://discord.com/invite/6M4QwDXn2w)
230+
- [Documentation](https://docs.falkordb.com)
231+
- Email: support@falkordb.com
232+
233+
---
234+
235+
<div align="center">
236+
If you find this repository helpful, please consider giving it a star!
237+
</div>

0 commit comments

Comments
 (0)