Skip to content

Commit 7fd3c6a

Browse files
authored
Fix Typos and Improve Clarity in Documentation (#1141)
This pull request includes several improvements to the documentation for Papermark. Key changes made include: - Fixed minor typos and grammatical errors. - Enhanced clarity and consistency in phrasing throughout the document. - Improved the formatting of lists for better readability. These updates aim to make the documentation more user-friendly and accessible for new contributors and users. Please review the changes and let me know if there are any additional suggestions or adjustments needed. Thank you!
1 parent db7620d commit 7fd3c6a

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@
2020

2121
<br/>
2222

23-
Papermark is the open-source document sharing alternative to DocSend with built-in analytics and custom domains.
23+
Papermark is the open-source document-sharing alternative to DocSend, featuring built-in analytics and custom domains.
2424

2525
## Features
2626

27-
- **Shareable Links:** Share your document securely by sending a custom link
28-
- **Custom Branding:** Add a custom domain and your own branding
29-
- **Analytics:** Get insights via document tracking and soon page-by-page analytics
30-
- **Self-hosted, open-source:** Host it yourself and hack on it
27+
- **Shareable Links:** Share your documents securely by sending a custom link.
28+
- **Custom Branding:** Add a custom domain and your own branding.
29+
- **Analytics:** Gain insights through document tracking and soon page-by-page analytics.
30+
- **Self-hosted, Open-source:** Host it yourself and customize it as needed.
3131

3232
## Demo
3333

@@ -36,7 +36,7 @@ Papermark is the open-source document sharing alternative to DocSend with built-
3636
## Tech Stack
3737

3838
- [Next.js](https://nextjs.org/) – Framework
39-
- [Typescript](https://www.typescriptlang.org/) – Language
39+
- [TypeScript](https://www.typescriptlang.org/) – Language
4040
- [Tailwind](https://tailwindcss.com/) – CSS
4141
- [shadcn/ui](https://ui.shadcn.com) - UI Components
4242
- [Prisma](https://prisma.io) - ORM [![Made with Prisma](https://made-with.prisma.io/dark.svg)](https://prisma.io)
@@ -51,7 +51,7 @@ Papermark is the open-source document sharing alternative to DocSend with built-
5151

5252
### Prerequisites
5353

54-
Here's what you need to be able to run Papermark:
54+
Here's what you need to run Papermark:
5555

5656
- Node.js (version >= 18.17.0)
5757
- PostgreSQL Database
@@ -93,11 +93,11 @@ npm run dev
9393

9494
Visit [http://localhost:3000](http://localhost:3000) in your browser.
9595

96-
## Tinybird instructions
96+
## Tinybird Instructions
9797

9898
To prepare the Tinybird database, follow these steps:
9999

100-
0. We use `pipenv` to manage my Python dependencies. If you don't have it installed, you can install it using the following command:
100+
0. We use `pipenv` to manage our Python dependencies. If you don't have it installed, you can install it using the following command:
101101
```sh
102102
pkgx pipenv
103103
```
@@ -106,7 +106,7 @@ To prepare the Tinybird database, follow these steps:
106106
```sh
107107
cd lib/tinybird
108108
```
109-
3. Push the necessary datasources using the following command:
109+
3. Push the necessary data sources using the following command:
110110
```sh
111111
tb push datasources/*
112112
tb push endpoints/get_*
@@ -126,9 +126,9 @@ pipenv update tinybird-cli
126126

127127
## Contributing
128128

129-
Papermark is an open-source project and we welcome contributions from the community.
129+
Papermark is an open-source project, and we welcome contributions from the community.
130130

131-
If you'd like to contribute, please fork the repository and make changes as you'd like. Pull requests are warmly welcome.
131+
If you'd like to contribute, please fork the repository and make any changes you'd like. Pull requests are warmly welcome.
132132

133133
### Our Contributors ✨
134134

0 commit comments

Comments
 (0)