Skip to content

Commit 12f5a21

Browse files
docs: 📝 Update Readme Content
Description & Details: - Improved README file overall. - Add Features and product description. - Add structure. Readme improved.
1 parent a9538a0 commit 12f5a21

File tree

2 files changed

+42
-20
lines changed

2 files changed

+42
-20
lines changed

LICENSE.md LICENSE

File renamed without changes.

README.md

+42-20
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,43 @@
1-
# Omniscient
1+
# Omniscient AI Platform
22

3-
It is a `SaaS` (Software as a Service), `AI Platform`
3+
Welcome to Omniscient, an advanced AI Platform offered as a SaaS (Software as a Service). Empower your projects with cutting-edge artificial intelligence capabilities across various domains. Built on a robust technology stack, Omniscient seamlessly integrates with Next.js 14, React, Typescript, and powerful APIs such as OpenAI and Replicate. This platform is designed to provide a comprehensive solution for code generation, conversation simulation, image creation, music composition, and video generation.
44

5-
### Stack
5+
## Key Features
66

7-
`Next.js 14, React, Typescript, OpenAI API, Replicate API, Clerk, Prisma, Zod, Postgres, Supabase, zustand, Stripe, Crisp, Tailwind, Shadcn-ui, Axios, React hook form, react hot toast, React markdown`.
7+
- **Free and Pro Plans**: Choose between free and pro plans tailored to meet your specific needs.
88

9-
## Getting Started
9+
- **User Settings**: Manage your experience with ease. Take control of account details, services, and monitor resource usage effortlessly.
1010

11-
First, run the development server:
11+
- **Multifaceted AI Models**:
12+
- **Code Generation**: Automate code creation with advanced models.
13+
- **Conversation Simulation**: Engage in realistic conversation simulations for diverse applications.
14+
- **Image Creation**: Generate stunning visuals with AI-powered image generation.
15+
- **Music Composition**: Unlock creativity with AI-generated musical compositions.
16+
- **Video Generation**: Seamlessly create videos for your projects with AI assistance.
1217

13-
```bash
14-
npm run dev
15-
# or
16-
yarn dev
17-
# or
18-
pnpm dev
19-
# or
20-
bun dev
21-
```
18+
## Technology Stack
2219

23-
### Store your keys on your .env or .env.local
20+
- **Frontend**: Next.js 14, React, Typescript, Clerk, Tailwind, Shadcn-ui.
21+
- **Backend**: Prisma, Postgres, Supabase.
22+
- **AI Integration**: OpenAI API, Replicate API.
23+
- **State Management**: Zustand.
24+
- **Form Handling**: React Hook Form.
25+
- **API Communication**: Axios.
26+
- **Notifications**: React Hot Toast.
27+
- **Markdown Rendering**: React Markdown.
28+
- **Payment Processing**: Stripe.
29+
- **Customer Support**: Crisp.
2430

25-
Create KEY's:
31+
## Getting Started
2632

27-
```
33+
1. Clone the repository
34+
2. Install dependencies: `npm install`
35+
3. Configure your environment variables.
36+
4. Run the application: `npm run dev`
37+
38+
### Store your keys on your .env or .env.local
2839

40+
```bash
2941
CLERK_SECRET_KEY
3042

3143
NEXT_PUBLIC_CLERK_SIGN_IN_URL
@@ -47,7 +59,6 @@ STRIPE_API_KEY
4759
STRIPE_WEBHOOK_SECRET
4860

4961
CRISP_TOKEN_ID
50-
5162
```
5263

5364
## For prisma
@@ -57,7 +68,6 @@ CRISP_TOKEN_ID
5768
npx prisma init # than make your changes on prisma schema with your provider and connection string
5869

5970
# Generate/Create tables
60-
6171
npx prisma generate
6272

6373
# Install prisma client
@@ -84,3 +94,15 @@ npx prisma migrate reset
8494
- $ stripe trigger (trigger events with the cli)
8595
- Keep dev running , prisma and stripe cli bash's
8696
- Go to stipe website and search customer portal and activate 'Activate test link'
97+
98+
## Contributing
99+
100+
Contributions are welcome to enhance Omniscient's capabilities. Whether it's fixing bugs, improving existing features, or proposing new ones, your input is valuable.
101+
102+
## Reporting Issues
103+
104+
If you encounter any issues or have suggestions for improvement, please [create an issue](https://github.com/your-username/omniscient/issues) on our GitHub repository.
105+
106+
## License
107+
108+
This project is licensed under the [MIT License](LICENSE).

0 commit comments

Comments
 (0)