From e9ff4ab40ca7d204e92a6d54643db7daf3915ede Mon Sep 17 00:00:00 2001 From: krhubert Date: Thu, 31 Jan 2019 12:42:47 +0100 Subject: [PATCH 1/2] Typo + grama --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 2e25c64bc..494f644fa 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ To help us build and maintain MESG Core, refer to the [Contribute](#contribute) # Quick Start Guide -This guide will show you steps-by-step how to create an application that sends a Discord invitation email when a webhook is called. +This guide will show you step-by-step how to create an application that sends a Discord invitation email when a webhook is called. ### 1. Installation @@ -62,23 +62,23 @@ You need to deploy every service your application is using. In this guide, the application is using 2 services. -Let's start by deploying the [webhook service](https://github.com/mesg-foundation/service-webhook): +Start by deploying the [webhook service](https://github.com/mesg-foundation/service-webhook): ```bash mesg-core service deploy https://github.com/mesg-foundation/service-webhook ``` -Now let's deploy the [invite discord service](https://github.com/mesg-foundation/service-discord-invitation): +Deploy the [invite discord service](https://github.com/mesg-foundation/service-discord-invitation): ```bash mesg-core service deploy https://github.com/mesg-foundation/service-discord-invitation ``` -Once the service is deployed, the console displays its Service ID. The Service ID is the unique way for the application to connect to the right service through MESG Core. You'll need to use them inside the application. +Once the service is deployed, the console displays its Service ID. The Service ID is a unique way for the application to connect to the right service through MESG Core. You'll need to use them inside the application. ### 4. Create the application -Now that the services are up and running, let's create the application. +Now when the services are up and running, let's create the application. The application is using [NodeJS](https://nodejs.org) and [NPM](https://www.npmjs.com/). @@ -90,7 +90,7 @@ Create and move your terminal to a folder that will contain the application. The npm init && npm install --save mesg-js ``` -Now, let's create an `index.js` file and with the following code: +Now, create an `index.js` file and with the following code: ```javascript const mesg = require('mesg-js').application() @@ -131,12 +131,12 @@ Don't forget to replace the values `__YOUR_EMAIL_HERE__` and `__SENDGRID_API_KEY ### 5. Start the services -Let's start the webook service: +Start the webhook service: ```bash mesg-core service start webhook ``` -Then let's the start discord invitation service: +Start discord invitation service: ```bash mesg-core service start discord-invitation ``` @@ -153,7 +153,7 @@ node index.js Now let's give this super simple application a try. -Let's trigger the webhook with the following command: +Trigger the webhook with the following command: ```bash curl -XPOST http://localhost:3000/webhook @@ -173,7 +173,7 @@ Services implement two types of communication: executing tasks and submitting ev Tasks have multiple input parameters and multiple outputs with varying data. A task is like a function with inputs and outputs. -Let's take an example of a task that sends a email: +Let's take an example of a task that sends an email: The task accepts as inputs: `receiver`, `subject` and `body`. @@ -191,9 +191,9 @@ Check out the documentation for more information on [how to create tasks](https: Services can also submit events to MESG Core. They allow two-way communication with MESG Core and Applications. -Let's say the service is a HTTP webserver. An event could be submitted when the webserver receives a request with the request's payload as the event's data. The service could also submit a specific event for every route of your API. +Let's say the service is an HTTP web server. An event could be submitted when the web server receives a request with the request's payload as the event's data. The service could also submit a specific event for every route of your API. -For more info how to create your events, visit the [Emit an Event](https://docs.mesg.com/guide/service/emit-an-event.html) page. +For more info on how to create your events, visit the [Emit an Event](https://docs.mesg.com/guide/service/emit-an-event.html) page. # Architecture From e40b302642bdaa15dd725507be51705569af2aac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C4=B0lker=20G=C3=B6ktu=C4=9F=20=C3=96zt=C3=BCrk?= Date: Thu, 31 Jan 2019 14:10:50 +0100 Subject: [PATCH 2/2] Apply suggestions from code review Grama fixes Co-Authored-By: krhubert --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 494f644fa..42fcaa35e 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ Deploy the [invite discord service](https://github.com/mesg-foundation/service-d mesg-core service deploy https://github.com/mesg-foundation/service-discord-invitation ``` -Once the service is deployed, the console displays its Service ID. The Service ID is a unique way for the application to connect to the right service through MESG Core. You'll need to use them inside the application. +Once the service is deployed, the console displays its id. This id is a unique way for the application to connect to the right service through MESG Core. You'll need to use them inside the application. ### 4. Create the application @@ -191,7 +191,7 @@ Check out the documentation for more information on [how to create tasks](https: Services can also submit events to MESG Core. They allow two-way communication with MESG Core and Applications. -Let's say the service is an HTTP web server. An event could be submitted when the web server receives a request with the request's payload as the event's data. The service could also submit a specific event for every route of your API. +Let's say the service is an HTTP web server. An event could be submitted when the web server receives a request with the request's payload as the event's data. The service could also submit a specific event for every route of your HTTP API. For more info on how to create your events, visit the [Emit an Event](https://docs.mesg.com/guide/service/emit-an-event.html) page.