fix #597 - Update README.md example and comment #598
Conversation
WalkthroughThe rebranding of RedisGraph to FalkorDB marks a significant shift, focusing on community collaboration, performance, and adaptability. This transformation involves updating the project's documentation and codebase to reflect the new identity, ensuring a seamless transition for users and contributors. Changes
Related issues
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 3
Configuration used: CodeRabbit UI
Files selected for processing (1)
- README.md (5 hunks)
Additional comments: 1
README.md (1)
- 82-82: The instructions for macOS users regarding the Clang version and OpenMP support could be clearer. Specifically, it's mentioned that running
brew install gcc g++is one way to resolve the issue, but it's not explicitly stated that users should then setCCandCXXto usegccandg++respectively if they choose not to update the symbolic links.Consider adding a note to explicitly state that after installing
gccandg++with Homebrew, users should set theCCandCXXenvironment variables to point to the newly installedgccandg++if they do not wish to update the symbolic links.
|
|
||
| # FalkorDB | ||
|
|
||
| > **Note** | ||
| > The team behind RedisGraph decided to take a stab at bringing this disruptive technology back to market. | ||
| > | ||
| > We plan to rebrand it and release it as a stand alone product, following the same guidelines we have followed for the last 6 years: | ||
| > | ||
| > * Working in the open with the community | ||
| > * Always provide superior performance. | ||
| > * Easy to adapt | ||
|
|
||
|
|
||
|
|
||
| --- | ||
|
|
||
| FalkorDB is the first queryable [Property Graph](https://github.com/opencypher/openCypher/blob/master/docs/property-graph-model.adoc) database to use [sparse matrices](https://en.wikipedia.org/wiki/Sparse_matrix) to represent the [adjacency matrix](https://en.wikipedia.org/wiki/Adjacency_matrix) in graphs and [linear algebra](http://faculty.cse.tamu.edu/davis/GraphBLAS.html) to query the graph. | ||
|
|
||
| Primary features: |
There was a problem hiding this comment.
📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [37-37]
The markdown link for "client libraries" seems to be broken due to a missing closing parenthesis. This could lead to confusion for readers trying to navigate to the client libraries section.
- Once loaded you can interact with FalkorDB using any of the supported [client libraries](#Client-libraries
+ Once loaded you can interact with FalkorDB using any of the supported [client libraries](#Client-libraries)📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [195-195]
There's a missing space between sentences in the description of the Rustis library. Adding a space would improve readability.
- | [Crate](https://crates.io/crates/rustis)|[Documentation](https://docs.rs/rustis/latest/rustis/commands/trait.GraphCommands.html) |
+ | [Crate](https://crates.io/crates/rustis) | [Documentation](https://docs.rs/rustis/latest/rustis/commands/trait.GraphCommands.html) || @@ -188,7 +179,7 @@ Some languages have client libraries that provide support for FalkorDB's command | |||
| | --------------------------------------------------------- | ---------- | ------- | ------------------------------------------- | ----------------------------------------------------------------- | ------- | ---------- | | |||
| | [jfalkordb][jfalkordb-url] | Java | BSD | [FalkorDB][falkordb-url] | ![Stars][jfalkordb-stars] | [Maven][jfalkordb-package]|| | |||
| | [falkordb-py][falkordb-py-url] | Python | MIT | [FalkorDB][falkordb-url] | ![Stars][falkordb-py-stars] | [pypi][falkordb-py-package]|| | |||
| | [node-falkordb][node-falkordb-url] | Node.JS | MIT | [FalkorDB][falkordb-url] | ![Stars][node-falkordb-stars] | [npm][node-falkordb-package]|| | |||
| | [falkordb-ts][falkordb-ts-url] | Node.JS | MIT | [FalkorDB][falkordb-url] | ![Stars][falkordb-ts-stars] | [npm][falkordb-ts-package]|| | |||
There was a problem hiding this comment.
The official spelling of "Node.JS" should be "Node.js". This is a minor typographical issue but correcting it would improve the professionalism of the document.
- | [falkordb-ts][falkordb-ts-url] | Node.JS | MIT | [FalkorDB][falkordb-url] | ![Stars][falkordb-ts-stars] | [npm][falkordb-ts-package]||
+ | [falkordb-ts][falkordb-ts-url] | Node.js | MIT | [FalkorDB][falkordb-url] | ![Stars][falkordb-ts-stars] | [npm][falkordb-ts-package]||Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| | [falkordb-ts][falkordb-ts-url] | Node.JS | MIT | [FalkorDB][falkordb-url] | ![Stars][falkordb-ts-stars] | [npm][falkordb-ts-package]|| | |
| | [falkordb-ts][falkordb-ts-url] | Node.js | MIT | [FalkorDB][falkordb-url] | ![Stars][falkordb-ts-stars] | [npm][falkordb-ts-package]|| |
Summary by CodeRabbit