Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the Read.me for the HN release #737

Merged
merged 20 commits into from
Jul 18, 2023
Prev Previous commit
Next Next commit
Update README.md
Updated content
  • Loading branch information
Bonapara committed Jul 18, 2023
commit 17d587a19896d2291b791557a5bed7646b5a60c9
93 changes: 71 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<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>
<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> · <a href="https://discord.com/invite/3Wneyvmn">Discord</a></p>
<br />

<p align="center">
Expand All @@ -24,51 +24,100 @@
</p>

# About
Twenty is an Open Source CRM designed to be :
- Enjoyable to use
- Easily extendable (soon)
- Perfectly in-sync with your data (soon)
At Twenty PBC, 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.
- 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. 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.

# 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:

<p align="center">
<a href="https://www.twenty.com">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="./docs/static/img/preview-dark.png">
<source media="(prefers-color-scheme: light)" srcset="./docs/static/img/preview-light.png">
<source media="(prefers-color-scheme: dark)" srcset="./docs/static/img/visualise-customer-dark.png">
<source media="(prefers-color-scheme: light)" srcset="./docs/static/img/visualise-customer-light.png">
<img src="./docs/static/img/preview-light.png" alt="Companies view" />
</picture>
</a>
</p>

You can create one or several opportunities for each companies:

<p align="center">
<a href="https://www.twenty.com">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="./docs/static/img/follow-your-deals-dark.png">
<source media="(prefers-color-scheme: light)" srcset="./docs/static/img/follow-your-deals-light.png">
<img src="./docs/static/img/preview-light.png" alt="Companies view" />
</picture>
</a>
</p>

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

<p align="center">
<a href="https://www.twenty.com">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="./docs/static/img/rich-notes-dark.png">
<source media="(prefers-color-scheme: light)" srcset="./docs/static/img/rich-notes-light.png">
<img src="./docs/static/img/preview-light.png" alt="Companies view" />
</picture>
</a>
</p>

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

<p align="center">
<a href="https://www.twenty.com">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="./docs/static/img/shortcut-navigation-dark.png">
<source media="(prefers-color-scheme: light)" srcset="./docs/static/img/shortcut-navigation-light.png">
<img src="./docs/static/img/preview-light.png" alt="Companies view" />
</picture>
</a>
</p>

# Progress
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 some specific feature, we'll do our best to ship them fast.
# Next developments
In the next two weeks we will release:

⚙️  A task system<br>
⚙️  A notification center<br>
⚙️  More standard fields<br>
⚙️  Pipelines and table customization<br>
⚙️  A new dark mode with higher contrasts<br>
⚙️  A lot of bug fixes and other improvements<br>

**In development**
⚙️  Pipelines customization
⚙️  More standard fields
Later this year we are considering releasing:
📅 Advanced search and filters<br>
📅  Auto-logging emails<br>
📅 Data connectors<br>
📅 Custom fields<br>
📅 +++<br>

**Planned**
📅  Activity log
📅  Auto-logging emails
📅  Search / Cmd + K
📅 Data connectors
📅 +++
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
Expand Down