Skip to content

Commit

Permalink
Merge pull request #1 from manekenpix/fix-readme
Browse files Browse the repository at this point in the history
fix: correct typo and add missing quotation mark
  • Loading branch information
humphd authored Feb 11, 2021
2 parents 57c5e3c + 6a304ec commit 92aafed
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ router.get('/', (req, res) => {
});

// Define your microservice, providing some options (see below)
const service = new Satellite({ name: 'my-service});
const service = new Satellite({ name: 'my-service'});

// Start the service on the specified port
service.start(8888, () => {
Expand All @@ -44,6 +44,6 @@ service.start(8888, () => {

- `healthCheck`: an optional `function` returning a `Promise`, used to determine if the service is healthy. If no function is defined, a default one will be provided. The `healthCheck` function is what runs at the `/healthcheck` route by default.

- `cors`: the options to pass to the [cors](https://www.npmjs.com/package/cors) middlware. By default all options are turned on. Use `cors: false` to disable cors.
- `cors`: the options to pass to the [cors](https://www.npmjs.com/package/cors) middleware. By default all options are turned on. Use `cors: false` to disable cors.

- `helmet`: the options to pass to the [helmet](https://www.npmjs.com/package/helmet) middleware. By default all options are turned on. Use `helmet: false` to disable helmet.

0 comments on commit 92aafed

Please sign in to comment.