Update README.md #1548
Update README.md #1548
Conversation
WalkthroughWalkthroughThe ZenStack toolkit for Node.js and TypeScript back-end development has enhanced its capabilities by upgrading the access control layer of Prisma ORM into a more robust and flexible Authorization layer. Additionally, new auto-generated, type-safe APIs and hooks have been introduced, enabling developers to maximize ZenStack’s potential for full-stack development. Changes
Tip Early access features: enabledWe are currently testing the following features in early access:
Note:
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.
Actionable comments posted: 0
Outside diff range and nitpick comments (7)
README.md (7)
Line range hint
173-173: Correct the spelling of ExpressJS.The official spelling of this framework is "Express.js".
- [ExpressJS](https://zenstack.dev/docs/reference/server-adapters/express) + [Express.js](https://zenstack.dev/docs/reference/server-adapters/express)
Line range hint
198-198: Add a hyphen to "Todo".The correct spelling is "To-do".
- ### Multi-Tenant Todo App + ### Multi-Tenant To-do App
Line range hint
200-200: Add a hyphen to "Todo".The correct spelling is "To-do".
- Check out the [Multi-tenant Todo App](https://zenstack-todo.vercel.app/) for a running example. + Check out the [Multi-tenant To-do App](https://zenstack-todo.vercel.app/) for a running example.
Line range hint
229-229: Consider using a stronger verb.The phrase "speed up the development" can be improved by using a stronger verb like "accelerate".
- to speed up the development. + to accelerate the development.
Line range hint
250-250: Consider improving the wording.The phrase "make ZenStack better" can be improved. Consider using "enhance ZenStack" or "improve ZenStack".
- thanks to all the contributors who have helped make ZenStack better! + thanks to all the contributors who have helped enhance ZenStack!
Line range hint
252-252: Correct the heading level.Heading levels should only increment by one level at a time.
- #### Source + ### Source
Line range hint
5-23: Add alt text to images.Images should have alternate text for accessibility.
- <img src="https://img.shields.io/npm/v/zenstack"> + <img src="https://img.shields.io/npm/v/zenstack" alt="npm version badge"> - <img src="https://img.shields.io/npm/dm/zenstack"> + <img src="https://img.shields.io/npm/dm/zenstack" alt="npm downloads badge"> - <img src="https://github.com/zenstackhq/zenstack/actions/workflows/build-test.yml/badge.svg"> + <img src="https://github.com/zenstackhq/zenstack/actions/workflows/build-test.yml/badge.svg" alt="build test badge"> - <img src="https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fzenstackhq%2Fzenstack"> + <img src="https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fzenstackhq%2Fzenstack" alt="twitter badge"> - <img src="https://img.shields.io/discord/1035538056146595961"> + <img src="https://img.shields.io/discord/1035538056146595961" alt="discord badge"> - <img src="https://img.shields.io/badge/license-MIT-green"> + <img src="https://img.shields.io/badge/license-MIT-green" alt="license badge"> - <img src="https://contrib.rocks/image?repo=zenstackhq/zenstack"> + <img src="https://contrib.rocks/image?repo=zenstackhq/zenstack" alt="contributors image"> - <img src="https://contrib.rocks/image?repo=zenstackhq/zenstack-docs"> + <img src="https://contrib.rocks/image?repo=zenstackhq/zenstack-docs" alt="docs contributors image">Also applies to: 255-261
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (1 hunks)
Additional context used
LanguageTool
README.md
[uncategorized] ~173-~173: The official spelling of this programming framework is “Express.js”.
Context: ...reference/server-adapters/fastify) - [ExpressJS](https://zenstack.dev/docs/reference/se...(NODE_JS)
[grammar] ~198-~198: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...) as an introduction. ### Multi-Tenant Todo App Check out the [Multi-tenant Todo A...(TO_DO_HYPHEN)
[grammar] ~200-~200: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...t Todo App Check out the Multi-tenant Todo App...(TO_DO_HYPHEN)
[style] ~229-~229: Consider using a different verb to strengthen your wording.
Context: ...ps://github.com/sponsors/zenstackhq) to speed up the development. Your contribution will...(SPEED_UP_ACCELERATE)
[style] ~250-~250: The wording of this phrase can be improved.
Context: ...to all the contributors who have helped make ZenStack better! #### Source <a href="https://github....(MAKE_STYLE_BETTER)
Markdownlint
README.md
252-252: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
5-5: null
Images should have alternate text (alt text)(MD045, no-alt-text)
10-10: null
Images should have alternate text (alt text)(MD045, no-alt-text)
13-13: null
Images should have alternate text (alt text)(MD045, no-alt-text)
15-15: null
Images should have alternate text (alt text)(MD045, no-alt-text)
17-17: null
Images should have alternate text (alt text)(MD045, no-alt-text)
20-20: null
Images should have alternate text (alt text)(MD045, no-alt-text)
23-23: null
Images should have alternate text (alt text)(MD045, no-alt-text)
255-255: null
Images should have alternate text (alt text)(MD045, no-alt-text)
261-261: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Additional comments not posted (1)
README.md (1)
29-29: LGTM!The description of ZenStack is clear and concise.
No description provided.