From c64a22ac69d5bb0cbec7f357941ac98615313ac0 Mon Sep 17 00:00:00 2001
From: Rachid F <109089247+rflihxyz@users.noreply.github.com>
Date: Thu, 14 Dec 2023 13:54:00 +0000
Subject: [PATCH] :memo: Update docs
update docs
---
README.md | 108 +++++++++++++++++++++++++++++-------------------------
1 file changed, 58 insertions(+), 50 deletions(-)
diff --git a/README.md b/README.md
index 10461fe3e..c95a84fb9 100644
--- a/README.md
+++ b/README.md
@@ -1,26 +1,66 @@
-# **Panora**
+
+
+
๐ผ Welcome on Panora
+
+
Panora puts your customer facing integration on autopilot
+
Ship dozens of integrations without losing sleep
+
+
+
+
+
+
+
+
+
+
+ Website ๐ - Documentation ๐ - Status ๐ข
+
+
+
+
+
+
-![Group 1_updated](https://github.com/panoratech/Panora/assets/39710677/c9a35848-7b48-43af-bd6c-6a5257e19bea)
-
-
-Our product makes it quick and easy for SaaS teams to ship customer-facing integrations between their product and others.
-We do so by providing a single API that abstracts similar tools your customer may use along your product behind a common data model.
+![Group 1_updated](https://github.com/panoratech/Panora/assets/39710677/c9a35848-7b48-43af-bd6c-6a5257e19bea)
+
+### Have you met anyone who loves developing integrations? *No.* Thatโs why we designed an easy developer experience that youโll enjoy.
+
+- **Simple developer experience:** easy to self-host, uses industry-standard data models, and is extensible
+- **Builder-friendly terms:** Panora is open-source, and offers generous tips for contributors
+
+### More than a devtool: Panora helps you put your product at the core of your customer's daily workflows
+
+Your customers expect all of their tools to work well together. Panora avoids your team spending hundreds of hours building and maintaining integrations instead of your core product.
+
+
+## ๐ฎ Core Features
+
+| |
+|---------------------------|
+| **Magic Links:** Let your users grant you access to their data. Without writing code. |
+| **Custom Fields:** Reflect in Panora the specific data points that matter to your users |
+| **Passthrough Requests:** Interact with other software platforms in their native format. |
+| **Flexible Sync Settings:** Businesses that need real-time update can configure Panora accordingly |
+| **Webhooks:** Listen to one webhook to receive normalized data from various software platforms |
+
-This way, you can write one code to push data anywhere!
+## ๐ค Core Values
-# ๐ป Try Self-hosted
+| |
+|-------------------------------------------|
+| ๐ป Easy Developer Experience |
+| ๐ซก Fair Value Share: Contributors are valuable, so we've decided to let our community tip our heroes |
-## Requirements
- 1. Install Docker on your machine.
- 2. Make sure Docker Compose is installed and available (it should be the case if you have chosen to install Docker via Docker Desktop).
- 3. Make sure Git is installed on your machine.
+## ๐น๏ธ Play with the Self-hosted version
+
+- Prerequisite: You should have Git and Docker installed
-## Run the app
1. Get the code
@@ -40,46 +80,14 @@ This way, you can write one code to push data anywhere!
docker compose --env-file ./.env.example up
```
-You can now open your browser and go to
to connect to the application. Panora's API is exposed at .
-Read more on our [quickstart guide](https://docs.panora.dev/quickstart)
-
-# โจ Join The cloud Pre-Alpha
-
-We're launching our clourd version soon. Click [here](https://form.typeform.com/to/KtthfECD) to get notified when we go public!
-
-# ๐ Roadmap
-
-CRMs:
-
-- [x] Hubspot
-- [x] Zoho CRM
-- [x] Pipedrive
-- [x] Salesforce
-- [x] Zendesk
-- [ ] Other CRMs such as Freshsales, MS 365...
-
-Ticketing:
+You can now open your browser and go to to connect to the application.
+Visit our [Quickstart Guide](https://docs.panora.dev/quick-start) to start adding integrations to your product
-- [ ] Slack
-- [ ] Discord
-- [ ] Jira
-- [ ] Asana
-- [ ] Microsoft Teams
+## ๐ค Have questions? Ask the core team
+
-Accounting:
-
-- [ ] Sage
-- [ ] Freshbooks
-- [ ] Clearbooks
-- [ ] FreeAgent
-
-...and more
-
-
-# ๐ Contributions
+## ๐ Contributions
This guide is intended for people willing to contribute to Panora.
-
You can follow this guide to set up a Panora development environment on your machine.
-
You can contribute by following our [guidelines.](https://github.com/panoratech/Panora/blob/main/CONTRIBUTING.md)