Skip to content

Commit 7b09dd3

Browse files
authored
[DOCS] readme update (#3)
1 parent f53bec6 commit 7b09dd3

File tree

2 files changed

+22
-5
lines changed

2 files changed

+22
-5
lines changed

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414

1515
Welcome to JamAI Base – the real-time database that orchestrates Large Language Models (LLMs) for you. Designed to simplify AI integration, JamAI Base offers a Backend as a Service (BaaS) platform with an intuitive, spreadsheet-like interface. Focus on defining your data requirements through natural language prompts, and let us handle the complexities of RAG, LLMOps, conversation histories, and LLM orchestration.
1616

17+
![JamAI Base Demo](jamaibase.webp)
18+
1719
## Key Benefits
1820

1921
### Ease of Use
@@ -110,7 +112,11 @@ Focus on defining "what" you want to achieve rather than "how" to achieve it.
110112
$ npm install jamaibase
111113
```
112114

113-
### Launch self-hosted services
115+
### Option 1: Use the JamAI Base Cloud
116+
117+
Get free LLM tokens on JamAI Base Cloud. [Sign up now.](https://cloud.jamaibase.com/)
118+
119+
### Option 2: Launch self-hosted services
114120

115121
1. Clone the repository:
116122

@@ -151,21 +157,32 @@ Focus on defining "what" you want to achieve rather than "how" to achieve it.
151157
- [API Documentation](https://jamaibase.readme.io)
152158
- [Platform Documentation](https://docs.jamaibase.com)
153159

160+
## Examples
161+
162+
Want to try building apps with JamAI Base? We've got some awesome examples to get you started! Check out our [example docs](https://docs.jamaibase.com/getting-started/use-case) for inspiration.
163+
164+
Here are a couple of cool frontend examples:
165+
166+
1. [Simple Chatbot Bot using NLUX](https://docs.jamaibase.com/getting-started/quick-start/nlux-frontend-only): Build a basic chatbot without any backend setup. It's a great way to dip your toes in!
167+
2. [Simple Chatbot Bot using NLUX + Express.js](https://docs.jamaibase.com/getting-started/quick-start/nlux-+-express.js): Take it a step further and add some backend power with Express.js.
168+
169+
Let us know if you have any questions – we're here to help! Happy coding! 😊
170+
154171
## Community and Support
155172

156173
Join our vibrant developer community for comprehensive documentation, tutorials, and resources:
157174

158-
- **Discord**: [Join our Discord](Discord_Link)
159-
- **GitHub**: [Star our GitHub repository](GitHub_Repository_Link)
175+
- **Discord**: [Join our Discord](https://discord.gg/rV6DECA8Dw)
176+
- **GitHub**: [Star our GitHub repository](https://github.com/EmbeddedLLM/JamAIBase)
160177

161178
## Contributing
162179

163180
We welcome contributions! Please read our [Contributing Guide](Contributing_Guide_Link) to get started.
164181

165182
## License
166183

167-
This project is licensed under the MIT License - see the [LICENSE](LICENSE_Link) file for details.
184+
This project is released under the Apache 2.0 License. - see the [LICENSE](https://github.com/EmbeddedLLM/JamAIBase/blob/main/LICENSE) file for details.
168185

169186
## Contact
170187

171-
Follow us on [LinkedIn](LinkedIn_Link) for updates and news.
188+
Follow us on [X](https://x.com/EmbeddedLLM) and [LinkedIn](https://www.linkedin.com/company/embedded-llm/) for updates and news.

jamaibase.webp

463 KB
Binary file not shown.

0 commit comments

Comments
 (0)