Skip to content
This repository was archived by the owner on Sep 2, 2022. It is now read-only.

Commit 030896d

Browse files
author
Markus Blomqvist
authored
Merge pull request #3 from apilytics/readme-fixes
Update readme texts
2 parents fea84e1 + 959dd16 commit 030896d

4 files changed

Lines changed: 18 additions & 18 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# apilytics-node
1+
# Apilytics for Node.js
22

33
[![ci](https://github.com/apilytics/apilytics-node/actions/workflows/ci.yml/badge.svg)](https://github.com/apilytics/apilytics-node/actions/workflows/ci.yml)
44
[![codecov](https://codecov.io/gh/apilytics/apilytics-node/branch/master/graph/badge.svg?token=K592YR52WQ)](https://codecov.io/gh/apilytics/apilytics-node)
55
[![typescript](https://badgen.net/badge/icon/typescript?icon=typescript&label&color=007acc)](https://www.typescriptlang.org)
66
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
77
[![license](https://img.shields.io/badge/license-MIT-green)](https://github.com/apilytics/apilytics-node/blob/master/LICENSE)
88

9-
Apilytics is a service that lets you analyze operational, performance and security metrics from your APIs without infrastructure-level logging.
9+
Apilytics is a service that lets you analyze operational, performance and security metrics from your APIs easily.
1010

1111
<img src="https://www.apilytics.io/mock-ups/time-frame.gif" alt="Apilytics dashboard animation" width="600" height="300" />
1212

packages/core/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[![node versions](https://img.shields.io/node/v/@apilytics/core)](#what-nodejs-versions-does-the-package-work-with)
99
[![license](https://img.shields.io/npm/l/@apilytics/core)](https://github.com/apilytics/apilytics-node/blob/master/packages/core/LICENSE)
1010

11-
Apilytics is a service that lets you analyze operational, performance and security metrics from your APIs without infrastructure-level logging.
11+
Apilytics is a service that lets you analyze operational, performance and security metrics from your APIs easily.
1212

1313
Make sure to check out our out-of-the-box middleware packages first:
1414

@@ -27,10 +27,10 @@ yarn add @apilytics/core
2727
npm install @apilytics/core
2828
```
2929

30-
3. Set your api key and create a middleware which measures the execution time and sends the metrics:
31-
*A good practice is to securely store the API key as an environment variable.
32-
You can leave the env variable unset in e.g. development and test environments,
33-
and make the middleware be disabled if the key is `undefined`.*
30+
3. Set your api key and create a middleware which measures the execution time and sends the metrics:\
31+
_A good practice is to securely store the API key as an environment variable.
32+
You can leave the env variable unset in e.g. development and test environments,
33+
and make the middleware be disabled if the key is `undefined`._
3434

3535
`my-apilytics-middleware.js`:
3636
```javascript
@@ -60,7 +60,7 @@ const myApilyticsMiddleware = async (req, handler) => {
6060
### Does the middleware slow down my backend?
6161

6262
- No. The middleware does all of its requests to the Apilytics API in the background, by using
63-
promises without awaiting them, so it will not slow down your normal request handling.
63+
promises without awaiting them, so it will not slow down your normal request handling.
6464

6565
### What 3rd party dependencies does `@apilytics/core` have?
6666

packages/express/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[![node versions](https://img.shields.io/node/v/@apilytics/express)](#what-nodejs-versions-does-the-package-work-with)
99
[![license](https://img.shields.io/npm/l/@apilytics/express)](https://github.com/apilytics/apilytics-node/blob/master/packages/express/LICENSE)
1010

11-
Apilytics is a service that lets you analyze operational, performance and security metrics from your APIs without infrastructure-level logging.
11+
Apilytics is a service that lets you analyze operational, performance and security metrics from your APIs easily.
1212

1313
## Installation
1414

@@ -21,10 +21,10 @@ yarn add @apilytics/express
2121
npm install @apilytics/express
2222
```
2323

24-
3. Enable the middleware and set your API key:
25-
*A good practice is to securely store the API key as an environment variable.
26-
You can leave the env variable unset in e.g. development and test environments,
27-
the middleware will be automatically disabled if the key is `undefined`.*
24+
3. Enable the middleware and set your API key:\
25+
_A good practice is to securely store the API key as an environment variable.
26+
You can leave the env variable unset in e.g. development and test environments,
27+
the middleware will be automatically disabled if the key is `undefined`._
2828

2929
`server.js`:
3030
```javascript

packages/next/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[![node versions](https://img.shields.io/node/v/@apilytics/next)](#what-nodejs-versions-does-the-package-work-with)
99
[![license](https://img.shields.io/npm/l/@apilytics/next)](https://github.com/apilytics/apilytics-node/blob/master/packages/next/LICENSE)
1010

11-
Apilytics is a service that lets you analyze operational, performance and security metrics from your APIs without infrastructure-level logging.
11+
Apilytics is a service that lets you analyze operational, performance and security metrics from your APIs easily.
1212

1313
## Installation
1414

@@ -21,10 +21,10 @@ yarn add @apilytics/next
2121
npm install @apilytics/next
2222
```
2323

24-
3. Enable the middleware and set your API key:
25-
*A good practice is to securely store the API key as an environment variable.
26-
You can leave the env variable unset in e.g. development and test environments,
27-
the middleware will be automatically disabled if the key is `undefined`.*
24+
3. Enable the middleware and set your API key:\
25+
_A good practice is to securely store the API key as an environment variable.
26+
You can leave the env variable unset in e.g. development and test environments,
27+
the middleware will be automatically disabled if the key is `undefined`._
2828

2929
`pages/api/my-route.js`:
3030
```javascript

0 commit comments

Comments
 (0)