zaid.marzguioui/myeasycms-v2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refine project information in README

Browse Source 
This commit enhances project information in README, including a more detailed development status notification and a more precise roadmap. It also includes renaming a configuration filename and providing a more comprehensive instruction. This caters to clearer expectations and better comprehension for users.
This commit is contained in:
giancarlo
2024-03-29 11:25:14 +08:00
parent 54852b2332
commit d8ead74a1b
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -4,7 +4,7 @@ This is a Starter Kit for building SaaS applications using Supabase, Next.js, an
This version uses Turborepo to manage multiple packages in a single repository.
**This project is currently under development. Please wait for the stable release before using it in production.**
**This project is currently under development. Please wait for the stable release before using it in production. It will undergo big changes and improvements.**
### Roadmap
@@ -13,7 +13,7 @@ The roadmap for the project is as follows:
1. **March 31**: Alpha release - authentication, personal accounts, team accounts (memberships)
2. **April 7**: Beta release - billing, Stripe, Lemon Squeezy, and more
3. **April 14**: Release candidate - admin dashboard, translations, and more
4. **April 21**: Final Release candidate - final features and improvements
4. **April 21**: Final Release candidate - in-app notifications, final features and improvements
5. **April 28**: Stable release - final features and improvements
6. **May 4**: Post-release - documentation, tutorials, and more
@@ -117,7 +117,7 @@ The configuration is defined in the `apps/web/config` folder. Here you can find
- **`feature-flags.config.ts`**: Feature flags configuration
- **`paths.config.ts`**: Paths configuration (e.g., routes, API paths, etc.)
- **`personal-account-sidebar.config.ts`**: Personal account sidebar configuration (e.g., links, icons, etc.)
- **`organization-account-sidebar.config.ts`**: Team account sidebar configuration (e.g., links, icons, etc.)
- **`team-account-sidebar.config.ts`**: Team account sidebar configuration (e.g., links, icons, etc.)
## Installing a Shadcn UI component
@@ -133,4 +133,4 @@ For example, to install the `Button` component, you can use the following comman
npx shadcn-ui@latest add button --path=packages/src/ui/shadcn
```
We pass the `--path` flag to specify the path where the component should be installed.
We pass the `--path` flag to specify the path where the component should be installed. You may need to adjust the path based on your project structure.