Update README and Documentation (#1875)
* Added Overview page * Revised Getting Started page * Minor revision * Edited readme, minor modifications to docs * Removed sweep.yaml, .devcontainer, .ergomake * Moved security.md to .github, added contributing.md * changes as per code review
This commit is contained in:
123
README.md
123
README.md
@ -7,11 +7,12 @@
|
||||
</p>
|
||||
|
||||
<h2 align="center" >A Modern Open Source CRM </h3>
|
||||
<p align="center">Crafted with Precision. Built for Success.</p>
|
||||
<p align="center">CRM flexibility, tailored to your unique business needs</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">Our Story</a> · 💬 <a href="https://discord.gg/cx5n4Jzs57">Discord</a> · ✏️ <a href="https://www.figma.com/file/xt8O9mFeLl46C5InWwoMrN/Twenty">Figma</a><p>
|
||||
<p align="center">🌐 <a href="https://twenty.com">Website</a> · 📚 <a href="https://docs.twenty.com">Documentation</a> · 💻 <a href="https://app.twenty.com/">Demo</a> · 💬 <a href="https://discord.gg/cx5n4Jzs57">Discord</a> · ✏️ <a href="https://www.figma.com/file/xt8O9mFeLl46C5InWwoMrN/Twenty">Figma</a><p>
|
||||
<br />
|
||||
|
||||
|
||||
<p align="center">
|
||||
<a href="https://www.twenty.com">
|
||||
<picture>
|
||||
@ -21,31 +22,37 @@
|
||||
</picture>
|
||||
</a>
|
||||
</p>
|
||||
<br>
|
||||
|
||||
# Quickstart
|
||||
Access the alpha version at [app.twenty.com](https://app.twenty.com). Click-to-deploy buttons for Render and Railway are coming soon.
|
||||
We’ve spent thousands of hours grappling with traditional CRMs/platforms like Pipedrive and Salesforce to align them with our business needs, only to end up frustrated—customizations are complex and the closed ecosystems of these platforms can feel restrictive.
|
||||
|
||||
For local setup, refer to [the documentation](https://docs.twenty.com/developer/local-setup). Expect a quick and easy startup.
|
||||
|
||||
# About
|
||||
We are building an Open Source CRM designed to be: enjoyable to use, easily extendable, and perfectly in-sync with your data.
|
||||
|
||||
Twenty was created as a Public Benefits Company. This means we're legally bound to consider the impact of our decisions not just on shareholders, but also on society.
|
||||
|
||||
Our belief is simple: **great companies focus on helping people** and meeting their users' needs above all. The decision to go open source was therefore a natural one for us. It fits with our aim to do what's right and with our goals for the business:
|
||||
|
||||
**For our users:**
|
||||
- We are committed to complete transparency regarding what we are building, allowing you to take a look inside and observe the intricate machinery in action.
|
||||
- This enables you to be a decisive actor of the roadmap by contributing or building your own tool.
|
||||
|
||||
**For the developer community:**
|
||||
- We offer a self-hosted CRM solution that you can use for free, keeping your data on your own servers.
|
||||
- We are developing a collection of reusable components, such as tables or kanban boards (coming soon).
|
||||
- We are introducing a new approach to CRM extensibility, one that can be managed by your engineering team instead of relying on external consultants (coming soon).
|
||||
We felt the need for a CRM solution that empowers rather than constrains, which inspired us to create Twenty. We’re building the next-generation open-source CRM that offers you the flexibility to shape it according to your business objectives and meet your team’s unique needs. We’ve packed Twenty with powerful features to give you full control and help you win more deals.
|
||||
|
||||
|
||||
# Features
|
||||
Explore [Twenty CRM](https://app.twenty.com/).
|
||||
|
||||
<br>
|
||||
|
||||
# Why Choose Twenty?
|
||||
We understand that the CRM landscape is vast. So why should you choose us?
|
||||
|
||||
⛓️ **Full control, Full Freedom:** With Twenty, you aren’t just a CRM user; you’re also a co-creator. Join us in shaping the future of CRM through open source collaboration. Break free from vendor lock-in and limitations.
|
||||
|
||||
📊 **Data, Your Way:** Your data should serve your business, not hinder it. Twenty allows you to harness the full potential of your data, securely and on your own terms.
|
||||
|
||||
🎨 **Effortlessly Intuitive:** We’ve made sure that Twenty’s design isn’t just beautiful, but also functional.
|
||||
It’s a CRM that your team will love to use.
|
||||
<br>
|
||||
|
||||
# Our Commitment
|
||||
|
||||
Twenty is incorporated as a Public Benefits Company, which means we’re legally bound to consider the broader impact of our decisions on all stakeholders. We strive to build software that creates value for a wider ecosystem, not just our company. Our success is intertwined with the success of our users, contributors, and the open source community at large.
|
||||
|
||||
<br>
|
||||
|
||||
# What You Can Do With Twenty
|
||||
We are currently in the development phase of Twenty's alpha version.
|
||||
|
||||
Don't hesitate to flag a specific need by creating an issue.
|
||||
|
||||
Below are the features we have implemented to date.
|
||||
@ -56,7 +63,7 @@ Below are the features we have implemented to date.
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/visualise-customer-dark.png">
|
||||
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/visualise-customer-light.png">
|
||||
<img src="./docs/static/img/preview-light.png" alt="Companies view" />
|
||||
<img src="./docs/static/img/visualise-customer-light.png" alt="Companies view" />
|
||||
</picture>
|
||||
</p>
|
||||
|
||||
@ -66,68 +73,66 @@ Below are the features we have implemented to date.
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/follow-your-deals-dark.png">
|
||||
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/follow-your-deals-light.png">
|
||||
<img src="./docs/static/img/preview-light.png" alt="Companies view" />
|
||||
<img src="./docs/static/img/follow-your-deals-light.png" alt="Companies view" />
|
||||
</picture>
|
||||
</p>
|
||||
|
||||
## Rich notes (and soon tasks) that are displayed in a timeline:
|
||||
## See rich notes tasks displayed in a timeline:
|
||||
|
||||
<p align="center">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/rich-notes-dark.png">
|
||||
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/rich-notes-light.png">
|
||||
<img src="./docs/static/img/preview-light.png" alt="Companies view" />
|
||||
<img src="./docs/static/img/rich-notes-light.png" alt="Companies view" />
|
||||
</picture>
|
||||
</p>
|
||||
|
||||
## Create tasks on records
|
||||
|
||||
<p align="center">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/create-tasks-dark.png">
|
||||
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/create-tasks-light.png">
|
||||
<img src="./docs/static/img/create-tasks-light.png" alt="Companies view" />
|
||||
</picture>
|
||||
</p>
|
||||
|
||||
|
||||
## Navigate quickly through the app using keyboard shortcuts and search:
|
||||
|
||||
<p align="center">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/shortcut-navigation-dark.png">
|
||||
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/main/docs/static/img/shortcut-navigation-light.png">
|
||||
<img src="./docs/static/img/preview-light.png" alt="Companies view" />
|
||||
<img src="./docs/static/img/shortcut-navigation-light.png" alt="Companies view" />
|
||||
</picture>
|
||||
</p>
|
||||
|
||||
# Upcoming features
|
||||
<br>
|
||||
|
||||
Coming next:
|
||||
⚙️ A notification center<br>
|
||||
⚙️ More standard fields<br>
|
||||
⚙️ AI/LLM integration to Notes<br>
|
||||
⚙️ More pipelines and table customization<br>
|
||||
⚙️ A lot of bug fixes and other improvements<br>
|
||||
⚙️ Auto-logging emails<br>
|
||||
# What's In Store
|
||||
|
||||
Coming later this year:
|
||||
📅 Advanced search and filters<br>
|
||||
📅 Data connectors<br>
|
||||
📅 Custom fields<br>
|
||||
📅 Custom objects<br>
|
||||
📅 +++<br>
|
||||
Here’s what you can look forward to:
|
||||
|
||||
Track planning on [Github Projects](https://github.com/orgs/twentyhq/projects/1) and help us prioritising by upvoting or creating [issues](https://github.com/twentyhq/twenty/issues)
|
||||
⏳ **Frequent updates:** We’re shipping fast! Expect regular updates and new features that enhance your CRM experience.
|
||||
|
||||
# Documentation
|
||||
The doc is available on [docs.twenty.com](https://docs.twenty.com).
|
||||
🔗 **Extensibility:** We’re putting the power in your hands. Soon, you’ll have the tools to extend and customize your CRM to precisely fit your business needs. No more reliance on external consultants; you’re in control.
|
||||
|
||||
If you have any question feel free to ask on our [Discord](https://discord.gg/cx5n4Jzs57).
|
||||
<br>
|
||||
|
||||
# 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 create an [issue](https://github.com/twentyhq/twenty/issues) to report a bug you've spotted, join [discussions](https://github.com/twentyhq/twenty/discussions), [Discord](https://discord.gg/cx5n4Jzs57) or write [documentation](https://docs.twenty.com/).
|
||||
# Join the Movement
|
||||
|
||||
- Star the repo
|
||||
- Join [discussions](https://github.com/twentyhq/twenty/discussions) and track [issues](https://github.com/twentyhq/twenty/issues)
|
||||
- Follow us on [Twitter](https://twitter.com/twentycrm) or [LinkedIn](https://www.linkedin.com/company/twenty/)
|
||||
- Join our [Discord](https://twenty.com/discord)
|
||||
- [Contributions](https://github.com/twentyhq/twenty/contribute) are, of course, most welcome!
|
||||
|
||||
# Office hours
|
||||
Want to meet the team? Get direct support?
|
||||
Feel free to book a slot during our office hours.
|
||||
<br>
|
||||
|
||||
# Get Started
|
||||
|
||||
Dive into Twenty today and experience the power of open-source CRM on your own terms.
|
||||
|
||||
🚀 [Get Started with Twenty](https://docs.twenty.com/developer/local-setup).
|
||||
|
||||
<a href="https://cal.com/team/twenty?utm_source=banner&utm_campaign=oss">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://cal.com/book-with-cal-dark.svg">
|
||||
<source media="(prefers-color-scheme: light)" srcset="https://cal.com/book-with-cal-light.svg">
|
||||
<img alt="Book us with Cal.com" src="https://cal.com/book-with-cal-light.svg" height="40">
|
||||
</picture>
|
||||
</a>
|
||||
|
||||
Reference in New Issue
Block a user