The Open Source DocuSign Alternative.
TypeScript digital-signaturedocument-signingdocusign-alternativee-signatureesignesignaturenext-authnextjsopen-sourcepades-standardpdfpdf-signpdf-signaturepostgresqlprismaself-hostedsigningtypescript
fix: typos and grammatical errors in readme (#616)
vimode1e5adb59cde2
diff --git a/README.md b/README.mdindex 140781421..ced30ed9e 100644--- a/README.md+++ b/README.md@@ -62,14 +62,14 @@ Join us in creating the next generation of open trust infrastructure.## Community and Next Steps π―-We're currently working on a redesign of the application, including a revamp of the codebase so Documenso can be more intuitive to use and robust to develop upon.+We're currently working on a redesign of the application, including a revamp of the codebase, so Documenso can be more intuitive to use and robust to develop upon.-- Check out the first source code release in this repository and test it-- Tell us what you think in the [Discussions](https://github.com/documenso/documenso/discussions)-- Join the [Discord server](https://documen.so/discord) for any questions and getting to know to other community members-- β the repository to help us raise awareness-- Spread the word on Twitter that Documenso is working towards a more open signing tool-- Fix or create [issues](https://github.com/documenso/documenso/issues), that are needed for the first production release+- Check out the first source code release in this repository and test it.+- Tell us what you think in the [Discussions](https://github.com/documenso/documenso/discussions).+- Join the [Discord server](https://documen.so/discord) for any questions and getting to know to other community members.+- β the repository to help us raise awareness.+- Spread the word on Twitter that Documenso is working towards a more open signing tool.+- Fix or create [issues](https://github.com/documenso/documenso/issues), that are needed for the first production release.## Contributing@@ -103,7 +103,7 @@ Contact us if you are interested in our Enterprise plan for large organizations### Requirements-To run Documenso locally you will need+To run Documenso locally, you will need- Node.js- Postgres SQL Database@@ -121,7 +121,7 @@ Want to get up and running quickly? Follow these steps:git clone https://github.com/documenso/documenso```-2. Set up your `.env` file using the recommendations in the `.env.example` file. Alternatively just run `cp .env.example .env` to get started with our handpicked defaults.+2. Set up your `.env` file using the recommendations in the `.env.example` file. Alternatively, just run `cp .env.example .env` to get started with our handpicked defaults.3. Run `npm run dx` in the root directory@@ -148,7 +148,7 @@ npm run d### Manual Setup-Follow these steps to setup documenso on you local machine:+Follow these steps to setup Documenso on your local machine:1. [Clone the repository](https://help.github.com/articles/cloning-a-repository/) it to your local device.@@ -156,11 +156,11 @@ Follow these steps to setup documenso on you local machine:git clone https://github.com/documenso/documenso```-2. Run `npm i` in root directory+2. Run `npm i` in the root directory3. Create your `.env` from the `.env.example`. You can use `cp .env.example .env` to get started with our handpicked defaults.-4. Set the following environement variables.+4. Set the following environment variables:- NEXTAUTH_URL- NEXTAUTH_SECRET@@ -173,15 +173,15 @@ git clone https://github.com/documenso/documenso5. Create the database schema by running `npm run prisma:migrate-dev`-6. Run `npm run dev` root directory to start+6. Run `npm run dev` in the root directory to start7. Register a new user at http://localhost:3000/signup----- Optional: Seed the database using `npm run prisma:seed -w @documenso/prisma` to create a test user and document-- Optional: Create your own signing certificate- - To generate your own using these steps and a Linux Terminal or Windows Subsystem for Linux (WSL) see **[Create your own signing certificate](./SIGNING.md)**.+- Optional: Seed the database using `npm run prisma:seed -w @documenso/prisma` to create a test user and document.+- Optional: Create your own signing certificate.+ - To generate your own using these steps and a Linux Terminal or Windows Subsystem for Linux (WSL), see **[Create your own signing certificate](./SIGNING.md)**.### Run in Gitpod@@ -195,15 +195,15 @@ We support DevContainers for VSCode. [Click here to get started.](https://vscode## Docker-π§ Docker containers and images are current in progress. We are actively working on bringing a simple docker build and publish pipeline for Documenso.+π§ Docker containers and images are current in progress. We are actively working on bringing a simple Docker build and publish pipeline for Documenso.## Self HostingWe support a variety of deployment methods, and are actively working on adding more. Stay tuned for updates!-> Please note the below deployment methods are for v0.9, we will update these to v1.0 once it has been released.+> Please note that the below deployment methods are for v0.9, we will update these to v1.0 once it has been released.-### Fetch, configure and build+### Fetch, configure, and buildFirst, clone the code from Github:@@ -250,7 +250,7 @@ This will start the server on `localhost:3000`. For now, any reverse proxy can t### Run as a service-You can use a systemd service file to run the app. Here is a simple example with the service running on port 3500 (using 3000 by default):+You can use a systemd service file to run the app. Here is a simple example of the service running on port 3500 (using 3000 by default):```bash[Unit]@@ -280,15 +280,15 @@ WantedBy=multi-user.target## Troubleshooting-### I'm not receiving any emails when using the developer quickstart+### I'm not receiving any emails when using the developer quickstart.-When using the developer quickstart an [Inbucket](https://inbucket.org/) server will be spun up in a docker container that will store all outgoing email locally for you to view.+When using the developer quickstart, an [Inbucket](https://inbucket.org/) server will be spun up in a docker container that will store all outgoing emails locally for you to view.-The Web UI can be found at http://localhost:9000 while the SMTP port will be on localhost:2500.+The Web UI can be found at http://localhost:9000, while the SMTP port will be on localhost:2500.### Support IPv6-In case you are deploying to a cluster that uses only IPv6. You can use a custom command to pass a parameter to the Next.js start command+If you are deploying to a cluster that uses only IPv6, You can use a custom command to pass a parameter to the Next.js start commandFor local docker run@@ -313,7 +313,7 @@ containers:- '::'```-### I can't see environment variables in my package scripts+### I can't see environment variables in my package scripts.Wrap your package script with the `with:env` script like such:@@ -321,7 +321,7 @@ Wrap your package script with the `with:env` script like such:npm run with:env -- npm run myscript```-The same can be done when using `npx` for one of bin scripts:+The same can be done when using `npx` for one of the bin scripts:```npm run with:env -- npx myscript