Skip to content

Commit 57586ba

Browse files
authored
docs: improve README clarity and fix grammar issues (calcom#29005)
* docs: fix grammar and improve clarity in README * docs: fix CSP section grammar and clarity
1 parent a69c176 commit 57586ba

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ To get a local copy up and running, please follow these simple steps.
7171

7272
### Prerequisites
7373

74-
Here is what you need to be able to run Cal.diy.
74+
Here’s what you need to run Cal.diy.
7575

7676
- Node.js (Version: >=18.x)
7777
- PostgreSQL (Version: >=13.x)
@@ -89,7 +89,8 @@ Here is what you need to be able to run Cal.diy.
8989
git clone https://github.com/calcom/cal.diy.git
9090
```
9191

92-
> If you are on Windows, run the following command on `gitbash` with admin privileges: <br> > `git clone -c core.symlinks=true https://github.com/calcom/cal.diy.git` <br>
92+
> If you are on Windows, run the following command in Git Bash with admin privileges:
93+
> `git clone -c core.symlinks=true https://github.com/calcom/cal.diy.git`
9394
9495
2. Go to the project folder
9596

@@ -116,7 +117,7 @@ Here is what you need to be able to run Cal.diy.
116117
> rm packages/prisma/.env && cp .env packages/prisma/.env
117118
> ```
118119
119-
5. Setup Node
120+
5. Set up Node
120121
If your Node version does not meet the project's requirements as instructed by the docs, "nvm" (Node Version Manager) allows using Node at the version required by the project:
121122
122123
```sh
@@ -201,7 +202,7 @@ for Logger level to be set at info, for example.
201202
<details>
202203
<summary>If you don't know how to configure the DATABASE_URL, then follow the steps here to create a quick local DB</summary>
203204

204-
1. [Download](https://www.postgresql.org/download/) and install postgres in your local (if you don't have it already).
205+
1. [Download](https://www.postgresql.org/download/) and install PostgreSQL locally (if you don't have it already).
205206

206207
2. Create your own local db by executing `createDB <DB name>`
207208

@@ -653,7 +654,7 @@ Unlike Cal.com's "Open Core" model, Cal.diy has **no commercial/enterprise code*
653654

654655
## Enabling Content Security Policy
655656

656-
- Set CSP_POLICY="non-strict" env variable, which enables [Strict CSP](https://web.dev/strict-csp/) except for unsafe-inline in style-src . If you have some custom changes in your instance, you might have to make some code change to make your instance CSP compatible. Right now it enables strict CSP only on login page and on other SSR pages it is enabled in Report only mode to detect possible issues. On, SSG pages it is still not supported.
657+
- Set CSP_POLICY="non-strict" env variable, which enables [Strict CSP](https://web.dev/strict-csp/) except for `unsafe-inline` in `style-src`. If you have custom changes in your instance, you may need to modify your code to make it CSP-compatible. Currently, strict CSP is enabled only on the login page. On other SSR pages, it is enabled in report-only mode to detect potential issues. It is not yet supported on SSG pages.
657658

658659
## Integrations
659660

@@ -673,8 +674,8 @@ Unlike Cal.com's "Open Core" model, Cal.diy has **no commercial/enterprise code*
673674

674675
#### _Adding google calendar to Cal.diy App Store_
675676

676-
After adding Google credentials, you can now Google Calendar App to the app store.
677-
You can repopulate the App store by running
677+
After adding Google credentials, you can now add the Google Calendar app to the App Store.
678+
You can repopulate the App Store by running
678679

679680
```
680681
cd packages/prisma

0 commit comments

Comments
 (0)