From 937867774471e45fcd6c5ab059e0131751383d8a Mon Sep 17 00:00:00 2001 From: Bonapara Date: Tue, 18 Jul 2023 20:22:39 +0200 Subject: [PATCH] Updated the Read.me for the HN release (#737) * Update README.md --------- Co-authored-by: Charles Bochet --- README.md | 121 ++++++++++++++++++++++-------- docs/static/img/preview-light.png | Bin 610396 -> 610030 bytes 2 files changed, 88 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 23899851b..deccbdbfd 100644 --- a/README.md +++ b/README.md @@ -9,60 +9,115 @@

A modern CRM Alternative

Engineer-Designed. Business-Ready. -

-

Website · Documentation · Story

+

Website · Documentation · Story · Discord


- - + + Companies view

# 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 +At Twenty, we are building an Open Source CRM designed to be: Enjoyable to use, easily extendable, perfectly in-sync with your data. We think that being open source will better serve our customer needs and could also benefit the open source community. + +**For our users:** +- Transparency on what we are building. +- An opportunity to be a decisive actor of your own tool by contributing to the roadmap. + +**For the community:** +- A CRM you can self-host for free under AGPL license +- The power of an Open-Source project backed by a funded company +- Reusuable components such as tables or kanban # 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. +- 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](https://github.com/twentyhq/twenty/issues) to report a bug you've spotted, join [discussions](https://github.com/twentyhq/twenty/discussions) or write documentation. # Quickstart -Soon, 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. +You can access and use the alpha version on [app.twenty.com](https://app.twenty.com), our cloud offering. We'll also release click-to-deploy buttons for Render and Railway. In the meantime, you can check [the documentation](https://docs.twenty.com/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. +If you have any question feel free to ask on our [Discord](https://discord.com/invite/3Wneyvmn) + +# Features +We are currently in the development phase of Twenty's alpha version. We are releasing new features on a biweekly basis. As mentionned above, do not hesitate to add issues if you need something specific, we'll do our best to ship it. + +You can add, filter, sort, edit and track your customers in a table: + +

+ + + + + Companies view + + +

+ +You can create one or several opportunities for each companies: + +

+ + + + + Companies view + + +

+ +You can create some rich notes (and very soon tasks) that will be displayed in a timeline: + +

+ + + + + Companies view + + +

+ +You can navigate quickly through the app using keyboard shortcuts and our integrated search: + +

+ + + + + Companies view + + +

+ +# Next developments + +⚙️  A task system
+⚙️  A notification center
+⚙️  More standard fields
+⚙️  Pipelines and table customization
+⚙️  A new dark mode with higher contrasts
+⚙️  A lot of bug fixes and other improvements
+ +Later this year we are considering releasing: +📅 Advanced search and filters
+📅  Auto-logging emails
+📅 Data connectors
+📅 Custom fields
+📅 +++
+ +Track the next features on [Github Projects](https://github.com/orgs/twentyhq/projects/1) and help us prioritising new ones by upvoting or adding [issues](https://github.com/twentyhq/twenty/issues) + # Office hours Want to meet the team? Get direct support? @@ -72,6 +127,6 @@ Feel free to book a slot during our office hours - Book us with Cal.com + Book us with Cal.com diff --git a/docs/static/img/preview-light.png b/docs/static/img/preview-light.png index 6eec4f94d87a112bc2c4a4e3c3ef7d2c8b3cfcce..10c7755f8c23b8c75cb514a6314ffd8824497cf4 100644 GIT binary patch delta 49 tcmcb!K=s{R)d|YY6B*klGJ-G@5HkZY3lOscF&hxG12M<;iHw}5{Q$o%5ODwi delta 406 zcmYL_y-ve06oo1O^eJqkj}>D~*d;2Se0-0;d++&vYJ5I79uJqbkdMY{?4Ns4n&2Q#Lx#&F+pwq8E3+V) zGX+96<$|K0w|4}1OwrA;@Az4t&G^|uvg^fg6fNeF8>3#g-YGo;NSF#hncRxpD=AuW zJ#)9u1c8-B%_&-r{Y%hKB?Bke!4B%yK}W_D?`m*b{WglCnNpcYNKq8HIKru%l9ubb z#A%auyJ;NF{9dS_Y>NEQBK{ZymPe9jil+itW)P-#iXvp{pn@yGC;xbnR{@wPh%yz@ z!VX#at@17;XQqt>Qq)4k4oj+O&E90axDo58hf