Improve documentation (#349)

* Improve documentation content
* Improve documentation style
This commit is contained in:
Félix Malfait
2023-06-21 16:23:31 -07:00
committed by GitHub
parent e679f45615
commit a65853dc2e
31 changed files with 15592 additions and 2194 deletions

View File

@ -29,32 +29,37 @@
</p>
# About
Twenty is an Open Source CRM designed to solve the issues that are still prevalent among the existings solutions.
It is meant to be:
Twenty is an Open Source CRM designed to be:
- Easily extendable
- Perfectly in-sync with your data
- Crafted with care and enjoyable to use
# Helping us
- The easiest way to help us is to star the repo and helping us getting visibility
- Contributions are, of course, most welcome! It doesn't have to be code, you could also create an issue to report a bug you've spotted, join discussions or write documentation.
# Quickstart
No need to clone the repo, just run `npx twenty-cli` in your terminal and follow the instructions.
By the first week of July, you should be able to try a demo directly on [app.twenty.com](https://app.twenty.com), our cloud offering with a generous free tier. We'll also release click-to-deploy buttons for Render and Railway.
In the meantime, you can check [the documentation](/start/local-setup). It shouldn't take more than a few minutes to install locally.
# Progress
We are currently in the development phase of Twenty's alpha version:
**Released**<br>
✅  Create Companies & People<br>
  View, filter and sort Companies & People<br>
**Released**
✅  Create Companies & People
View, filter and sort Companies & People
✅  Comments
**In development**<br>
⚙️  Pipe views (Opportunities)<br>
⚙️  Comments<br>
**In development**
⚙️  Pipelines
⚙️  Custom Fields
**Planned**<br>
📅  Email logging<br>
📅  Custom Fields<br>
📅  Search / Cmd + K<br>
📅 Data connexion<br>
**Planned**
📅  Activity log
📅  Auto-logging emails
📅  Search / Cmd + K
📅 Data connectors
📅 +++
# Documentation