twenty/README.md
Félix Malfait a65853dc2e
Improve documentation (#349)
* Improve documentation content
* Improve documentation style
2023-06-21 16:23:31 -07:00

69 lines
2.3 KiB
Markdown

</br>
<p align="center">
<a href="https://www.twenty.com#gh-dark-mode-only">
<img src="./docs/static/img/logo-square-dark.svg" width="100px" alt="Twenty logo" />
</a>
<a href="https://www.twenty.com#gh-light-mode-only">
<img src="./docs/static/img/logo-square-dark.svg" width="100px" alt="Twenty logo" />
</a>
</p>
<h2 align="center" >A modern CRM Alternative</h3>
<p align="center">Engineer-Designed. Business-Ready.
</p>
<p align="center"><a href="https://twenty.com">Website</a> · <a href="https://docs.twenty.com">Documentation</a> · <a href="https://twenty.com/story">Story</a></p>
<br />
<p align="center">
<a href="https://www.twenty.com#gh-dark-mode-only">
<img src="./docs/static/img/preview-dark.png" alt="Companies view" />
</a>
</p>
<p align="center">
<a href="https://www.twenty.com#gh-light-mode-only">
<img src="./docs/static/img/preview-light.png" alt="Companies view" />
</a>
</p>
# About
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
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**
✅  Create Companies & People
✅ View, filter and sort Companies & People
✅  Comments
**In development**
⚙️  Pipelines
⚙️  Custom Fields
**Planned**
📅  Activity log
📅  Auto-logging emails
📅  Search / Cmd + K
📅 Data connectors
📅 +++
# Documentation
The doc is available on [docs.twenty.com](https://docs.twenty.com)
We don't have a Slack community yet but we will create one when we are ready to launch.
In the meantime, feel free to create a Github issue or open a discussion.