From 48f318a82470e7808cce7d7317532e6b567eb34d Mon Sep 17 00:00:00 2001 From: Aditya Aryaman Das <128703909+alienishi@users.noreply.github.com> Date: Wed, 18 Oct 2023 01:27:28 +0530 Subject: [PATCH 1/2] docs: corrected grammatical errors in README.md --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 804823f524..08ad3456e4 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -ToolJet is an **open-source low-code framework** to build and deploy internal tools with minimal engineering effort. ToolJet's drag and drop frontend builder allows you to create complex, responsive frontends within minutes. Additionally, you can integrate various data sources, including databases like PostgreSQL, MongoDB, and Elasticsearch; API endpoints with OpenAPI spec and OAuth2 support; SaaS tools such as Stripe, Slack, Google Sheets, Airtable, and Notion; as well as object storage services like S3, GCS, and Minio, to fetch and write data. +ToolJet is an **open-source low-code framework** to build and deploy internal tools with minimal engineering effort. ToolJet's drag-and-drop frontend builder allows you to create complex, responsive frontends within minutes. Additionally, you can integrate various data sources, including databases like PostgreSQL, MongoDB, and Elasticsearch; API endpoints with OpenAPI spec and OAuth2 support; SaaS tools such as Stripe, Slack, Google Sheets, Airtable, and Notion; as well as object storage services like S3, GCS, and Minio, to fetch and write data. ⭐ If you find ToolJet useful, please consider giving us a star on GitHub! Your support helps us continue to innovate and deliver exciting features. @@ -59,7 +59,7 @@ ToolJet is an **open-source low-code framework** to build and deploy internal to - **Granular access control:** Set permissions at both group and app levels. - **Low-code:** Use JS code almost anywhere within the builder, such as setting text color based on status with `status === 'success' ? 'green' : 'red`. -- **No-code query editors:** Query Editors available for all supported data sources. +- **No-code query editors:** Query Editors are available for all supported data sources. - **Join and transform data:** Transform query results using JavaScript or Python code. - **Secure:** All the credentials are securely encrypted using `aes-256-gcm`. - **Data Privacy:** ToolJet serves solely as a proxy and does not store data. @@ -70,7 +70,7 @@ ToolJet is an **open-source low-code framework** to build and deploy internal to ## Quickstart The easiest way to get started with ToolJet is by creating a [ToolJet Cloud](https://tooljet.com) account. ToolJet Cloud offers a hosted solution of ToolJet. If you want to self-host ToolJet, kindly proceed to [deployment documentation](https://docs.tooljet.com/docs/setup/). -You can deploy ToolJet on Heroku using one-click-deployment. +You can deploy ToolJet on Heroku using one-click deployment.

Deploy to Heroku @@ -78,7 +78,7 @@ You can deploy ToolJet on Heroku using one-click-deployment.

### Try using Docker -Want to give ToolJet a quick spin on your local machine? You can run the following command from your terminal to have ToolJet up and running right away. +Want to give ToolJet a quick spin on your local machine? You can immediately run the following command from your terminal to have ToolJet up. ```bash docker run \ @@ -103,7 +103,7 @@ Documentation is available at https://docs.tooljet.com. - [Component Reference](https://docs.tooljet.com/docs/widgets/button) ## Self-hosted -You can use ToolJet Cloud for a fully managed solution. If you want to self-host ToolJet, we have guides on deploying ToolJet on Kubernetes, AWS EC2, Docker, Heroku and more. +You can use ToolJet Cloud for a fully managed solution. If you want to self-host ToolJet, we have guides on deploying ToolJet on Kubernetes, AWS EC2, Docker, Heroku, and more. | Provider | Documentation | | :------------- | :------------- | @@ -123,7 +123,7 @@ You can use ToolJet Cloud for a fully managed solution. If you want to self-host | Deploying ToolJet on a Subpath | [Link](https://docs.tooljet.com/docs/setup/tooljet-subpath/) | ## Marketplace -ToolJet can now be found on both AWS and Azure Marketplaces, making it simpler than ever to access and deploy our app-building platform. +ToolJet can now be found on both AWS and Azure Marketplaces, making accessing and deploying our app-building platform simpler than ever. Find ToolJet on AWS Marketplace [here](https://aws.amazon.com/marketplace/pp/prodview-fxjto27jkpqfg?sr=0-1&ref_=beagle&applicationId=AWSMPContessa) and explore seamless integration on Azure Marketplace [here](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/tooljetsolutioninc1679496832216.tooljet?tab=Overview). @@ -132,10 +132,10 @@ For general help using ToolJet, please refer to the official [documentation](htt - [Slack](https://tooljet.com/slack) - Discussions with the community and the team. - [GitHub](https://github.com/ToolJet/ToolJet/issues) - For bug reports and feature requests. -- [Twitter](https://twitter.com/ToolJet) - Get the product updates easily. +- [Twitter](https://twitter.com/ToolJet) - Get the product updates quickly. ## Roadmap -Check out our [roadmap](https://github.com/ToolJet/ToolJet/projects/2) to stay updated on recently released features and to learn about what's coming next. +Check out our [roadmap](https://github.com/ToolJet/ToolJet/projects/2) to stay updated on recently released features and learn about what's coming. ## Branching model We use the git-flow branching model. The base branch is `develop`. If you are looking for a stable version, please use the main branch or tags labeled as v1.x.x. From 4b70f92a4184b020762552a5250e73268b6dbbd5 Mon Sep 17 00:00:00 2001 From: Aditya Aryaman Das <128703909+alienishi@users.noreply.github.com> Date: Sat, 21 Oct 2023 23:30:35 +0530 Subject: [PATCH 2/2] Updated README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 08ad3456e4..5dd66c1154 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,7 @@ You can deploy ToolJet on Heroku using one-click deployment.

### Try using Docker -Want to give ToolJet a quick spin on your local machine? You can immediately run the following command from your terminal to have ToolJet up. +Want to give ToolJet a quick spin on your local machine? You can run the following command from your terminal to have ToolJet up and running right away. ```bash docker run \ @@ -123,7 +123,7 @@ You can use ToolJet Cloud for a fully managed solution. If you want to self-host | Deploying ToolJet on a Subpath | [Link](https://docs.tooljet.com/docs/setup/tooljet-subpath/) | ## Marketplace -ToolJet can now be found on both AWS and Azure Marketplaces, making accessing and deploying our app-building platform simpler than ever. +ToolJet can now be found on both AWS and Azure Marketplaces, making it simpler than ever to access and deploy our app-building platform. Find ToolJet on AWS Marketplace [here](https://aws.amazon.com/marketplace/pp/prodview-fxjto27jkpqfg?sr=0-1&ref_=beagle&applicationId=AWSMPContessa) and explore seamless integration on Azure Marketplace [here](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/tooljetsolutioninc1679496832216.tooljet?tab=Overview). @@ -135,7 +135,7 @@ For general help using ToolJet, please refer to the official [documentation](htt - [Twitter](https://twitter.com/ToolJet) - Get the product updates quickly. ## Roadmap -Check out our [roadmap](https://github.com/ToolJet/ToolJet/projects/2) to stay updated on recently released features and learn about what's coming. +Check out our [roadmap](https://github.com/ToolJet/ToolJet/projects/2) to stay updated on recently released features and learn about what's coming next. ## Branching model We use the git-flow branching model. The base branch is `develop`. If you are looking for a stable version, please use the main branch or tags labeled as v1.x.x.