chore: update README.md #1323
chore: update README.md #1323
Conversation
Signed-off-by: Nitish Tiwari <nitish@parseable.com>
WalkthroughThe README.md file was updated to consistently rename the product from "Parseable" to "ParseableDB" and the UI to "Prism(Parseable UI)". All documentation, usage instructions, and references were revised to reflect the new branding, with no functional or command changes made. Changes
Poem
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Note ⚡️ Faster reviews with cachingCodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
README.md (4)
20-20: Suggest adding missing article and improving hyphenation.
The sentence “ParseableDB is built with focus on simplicity & resource efficiency” reads better as “built with a focus” and “cloud-native” should be hyphenated.- ParseableDB is a disk **_less_**, cloud native database for logs, observability, security, and compliance. ParseableDB is built with focus on simplicity & resource efficiency. It is useful for use cases where **complete data ownership, data security and privacy are paramount**. + ParseableDB is a disk **_less_**, cloud-native database for logs, observability, security, and compliance. ParseableDB is built with a focus on simplicity & resource efficiency. It is useful for use cases where **complete data ownership, data security, and privacy are paramount**.🧰 Tools
🪛 LanguageTool
[uncategorized] ~20-~20: You might be missing the article “a” here.
Context: ...d compliance. ParseableDB is built with focus on simplicity & resource efficiency. It...(AI_EN_LECTOR_MISSING_DETERMINER_A)
22-22: Correct verb form: “check out” instead of “checkout”.
The phrase “checkout” here should be two words when used as a verb.- To experience Prism(Parseable UI), checkout [demo.parseable.com ↗︎](https://demo.parseable.com/login?q=…). + To experience Prism(Parseable UI), check out [demo.parseable.com ↗︎](https://demo.parseable.com/login?q=…).
82-82: Improve login wording and grammar.
Use “log in” and add “using” for clarity.- Access the UI at [http://localhost:8000 ↗︎](http://localhost:8000). You can login to the dashboard default credentials `admin`, `admin`. + Access the UI at [http://localhost:8000 ↗︎](http://localhost:8000). You can log in to the dashboard using the default credentials `admin` / `admin`.🧰 Tools
🪛 LanguageTool
[misspelling] ~82-~82: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...000 ↗︎](http://localhost:8000). You can login to the dashboard default credentials `a...(LOG_IN)
88-88: Refine phrasing: add missing preposition.
Modify to “elaborates on the available options” for grammatical correctness.- This section elaborates available options to run ParseableDB in production or development environments. + This section elaborates on the available options to run ParseableDB in production or development environments.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(4 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~20-~20: You might be missing the article “a” here.
Context: ...d compliance. ParseableDB is built with focus on simplicity & resource efficiency. It...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[misspelling] ~82-~82: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...000 ↗︎](http://localhost:8000). You can login to the dashboard default credentials `a...
(LOG_IN)
[uncategorized] ~86-~86: Possible missing preposition found.
Context: ...g started 💡 For quickstart, refer the [quickstart section ↗︎](#quickstart-zap...
(AI_HYDRA_LEO_MISSING_TO)
🔇 Additional comments (5)
README.md (5)
26-26: Consistent branding: Heading update looks good.
The section heading now correctly references “ParseableDB”.
32-32: Consistent branding in Docker quickstart.
The Docker command now references “ParseableDB” appropriately. LGTM.
47-47: Consistent branding in binary quickstart.
The binary installation instructions correctly rename to “ParseableDB”.
67-67: Consistent branding in ingestion example.
The ingestion command accurately uses “ParseableDB”.
90-91: Consistent branding in deployment options.
Both bullet points correctly mention “ParseableDB” in the distributed setup links.
Summary by CodeRabbit