Skip to content

Commit

Permalink
πŸ“š Improved Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
victorforissier committed Oct 15, 2023
1 parent c1843a7 commit 59057cb
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 19 deletions.
51 changes: 33 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,50 @@

<h4 align="center">
<a href="https://docs.polyfire.com">Documentation</a> |
<a href="https://discord.gg/8mkBfDXNTM">Discord</a>
<a href="https://www.polyfire.com/discord">Discord</a> | <a href="https://beta.polyfire.com">Dashboard</a>
</h4>

<p align="center">⚑ An all-in-one managed backend for AI apps. Build AI apps from the frontend πŸͺΆ</p>
<p align="center">⚑ An all-in-one managed backend for AI apps. Build AI apps from the frontend, very fast. πŸͺΆ</p>

Polyfire helps you build much faster by centralizing all the AI backend tools in one easy-to-use Front End SDK.
Why use Polyfire?
* Just code from the frontend, no backend needed
* If you already have backend, less code to write
* Most services you'd need in a couple lines of code

## ✨ Getting started
It's a **managed backend**, we help you save time, by managing your AI backend.

We also made a couple of tutorials you can use to get started with Polyfire:
![Demo Gif](https://files.readme.io/7442014-demo.gif)

## πŸ†• Getting Started

- **[Getting Started](https://docs.polyfire.com/docs/basic-usage)**
- **[Tutorial: How to make a clone of ChatGPT](https://docs.polyfire.com/docs/chatgpt-clone)**
- **[Tutorial: Add stripe subscriptions](https://docs.polyfire.com/docs/react-stripe-subscriptions)**
To get an overview of Polyfire follow this **[Basic Usage](https://docs.polyfire.com/docs/basic-usage)** tutorial.

## πŸ“š Documentation
## ✨ Starter Guides

- **[Generate Simple Text](https://docs.polyfire.com/docs/generate)**: Answer to simple requests as text
- **[Create Chatbots](https://docs.polyfire.com/docs/chats)**: Easily create chatbots
- **[Transcribe](https://docs.polyfire.com/docs/transcribe)**: Transcribe audio files to text
- **[Memory](https://docs.polyfire.com/docs/memory)**: Easily create a long-term memory and simplify the use of large amounts of information
- **[GenerateImage](https://docs.polyfire.com/docs/generate-image)**: Generate images with Dall-E
We also made a couple of tutorials you can use to get started with Polyfire:

- **[How to make a clone of ChatGPT](https://docs.polyfire.com/docs/chatgpt-clone)**
- **[New Project & Rate Limits](https://docs.polyfire.com/docs/new-project-rate-limit)**
- **[Adding stripe subscriptions](https://docs.polyfire.com/docs/react-stripe-subscriptions)**
- **[Call Polyfire from React](https://docs.polyfire.com/docs/usepolyfire)**: The usePolyfire hooks lets you use Polyfire and handle authentification without having to deploy any backend
- **[Call Polyfire from other browser environments](https://docs.polyfire.com/docs/javascript)**: The Polyfire Client Object allows you to use Polyfire and handle authentification without having to deploy any backend in any environment

## πŸ“« Contact us
## πŸ“š Useful References

- **[Generate Simple Text](https://docs.polyfire.com/reference/generate)**: Answer to simple requests as text
- **[Create Chatbots](https://docs.polyfire.com/reference/chats)**: Easily create chatbots
- **[Transcribe](https://docs.polyfire.com/reference/transcribe)**: Transcribe audio files to text
- **[Memory](https://docs.polyfire.com/reference/embeddings)**: Easily create a long-term memory and simplify the use of large amounts of information
- **[GenerateImage](https://docs.polyfire.com/reference/generate-image)**: Generate images with Dall-E
-

We strive for feedback and want to understand everyone's needs, and you can hang out with us on [Discord](https://discord.gg/8mkBfDXNTM)!
## πŸ”— Links

## πŸ§‘β€πŸ’» Contributing
* Website: [polyfire.com](https://www.polyfire.com)
* Documentation: [docs.polyfire.com](https://docs.polyfire.com)
* Dashboard: [beta.polyfire.com](https://beta.polyfire.com)
* Discord: [polyfire.com/discord](https://www.polyfire.com/discord)
* Javascript SDK: [github.com/polyfire-ai/polyfire-js](https://www.github.com/polyfire-ai/polyfire-js)
* Open Source API (your managed backend!): [github.com/polyfire-ai/polyfire-api-go](https://www.github.com/polyfire-ai/polyfact-api-go)

PolyFire is open-source! You can contribute to the [Javascript SDK](https://github.com/polyfire-ai/polyfire-js) or the [API](https://github.com/polyfire-ai/polyfire-api) by opening an issue or a PR!
We're open source! Make a good PR to the JS SDK or the API and we'll merge it.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "polyfire-js",
"version": "0.2.1",
"version": "0.2.2",
"main": "index.js",
"types": "index.d.ts",
"author": "Lancelot Owczarczak <lancelot@owczarczak.fr>",
Expand Down

0 comments on commit 59057cb

Please sign in to comment.