From 663c4d5c3f374f69847b455a71ec09167f953642 Mon Sep 17 00:00:00 2001 From: Max Mergenthaler Date: Wed, 19 Jul 2023 23:34:19 -0700 Subject: [PATCH] doc: Update README.md with suggestions (#773) Update README.md with suggestions I changed some minor stuff for readability. --- README.md | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index c554fe4a0582..154f0f89ed96 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,9 @@

A Modern Open Source CRM

-

Crafted with Engineer-Precision. Built for Business-Success.

+

Crafted with Precision. Built for Success.

-

Website 路 Documentation 路 Story 路 Discord

+

馃寪 Website 路 馃摎 Documentation 路 馃摉 Our Story 路 馃挰 Discord


@@ -23,24 +23,23 @@

# Quickstart -You can access and use the alpha version on [app.twenty.com](https://app.twenty.com). -Soon, we will release click-to-deploy buttons for Render and Railway. +Access the alpha version at [app.twenty.com](https://app.twenty.com). Click-to-deploy buttons for Render and Railway are coming soon. -For a local setup, please check [the documentation](https://docs.twenty.com/developer/local-setup). -It's a straightforward process that should have you up and running in minutes. +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: + +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 own your own servers. +- 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). @@ -51,7 +50,7 @@ Don't hesitate to flag a specific need by creating an issue. Below are the features we have implemented to date. -You can add, filter, sort, edit and track your customers: +## Add, filter, sort, edit and track customers:

@@ -61,7 +60,7 @@ You can add, filter, sort, edit and track your customers:

-You can create one or several opportunities for each company: +## Create one or several opportunities for each company:

@@ -71,7 +70,7 @@ You can create one or several opportunities for each company:

-You can create rich notes (and soon tasks) that are displayed in a timeline: +## Rich notes (and soon tasks) that are displayed in a timeline:

@@ -81,7 +80,7 @@ You can create rich notes (and soon tasks) that are displayed in a timeline:

-You can navigate quickly through the app using keyboard shortcuts and search: +## Navigate quickly through the app using keyboard shortcuts and search: