Merge pull request #2 from apilytics/readme-changes

README and type import changes

Author: ruohola

README.md

@@ -6,14 +6,18 @@
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
 [![license](https://img.shields.io/badge/license-MIT-green)](https://github.com/apilytics/apilytics-node/blob/master/LICENSE)
 
+Apilytics is a service that lets you analyze operational, performance and security metrics from your APIs without infrastructure-level logging.
+
+<img src="https://www.apilytics.io/mock-ups/time-frame.gif" alt="Apilytics dashboard animation" width="600" height="300" />
+
 ## Installation
 
 1. Sign up and get your API key from https://apilytics.io - we offer a completely free trial with no credit card required!
 
-2. Check installation directions for your specific framework:
+2. Continue with installation directions for your specific framework:
 
-- [**Express**](./packages/express/README.md#installation)
+- [**Express** (`@apilytics/express`)](./packages/express/README.md#installation)
 
-- [**Next.js**](./packages/next/README.md#installation)
+- [**Next.js** (`@apilytics/next`)](./packages/next/README.md#installation)
 
-- [**Other Node.js Frameworks**](./packages/core/README.md#installation)
+- [**Other Node.js Frameworks** (`@apilytics/core`)](./packages/core/README.md#installation)

packages/core/README.md

@@ -8,11 +8,13 @@
 [![node versions](https://img.shields.io/node/v/@apilytics/core)](#what-nodejs-versions-does-the-package-work-with)
 [![license](https://img.shields.io/npm/l/@apilytics/core)](https://github.com/apilytics/apilytics-node/blob/master/packages/core/LICENSE)
 
+Apilytics is a service that lets you analyze operational, performance and security metrics from your APIs without infrastructure-level logging.
+
 Make sure to check out our out-of-the-box middleware packages first:
 
-- [**Express**](../express/README.md#installation)
+- [**Express** (`@apilytics/express`)](../express/README.md#installation)
 
-- [**Next.js**](../next/README.md#installation)
+- [**Next.js** (`@apilytics/next`)](../next/README.md#installation)
 
 ## Installation
 
@@ -28,24 +30,28 @@ npm install @apilytics/core
 3. Set your api key and create a middleware which measures the execution time and sends the metrics:
 *A good practice is to securely store the API key as an environment variable.  
 You can leave the env variable unset in e.g. development and test environments,
-the middleware will be automatically disabled if the key is `undefined`.*
+and make the middleware be disabled if the key is `undefined`.*
 
 `my-apilytics-middleware.js`:
 ```javascript
 import { milliSecondTimer, sendApilyticsMetrics } from '@apilytics/core';
 
-const myApilyticsMiddleware = (/* ... */) => {
-  const timer = milliSecondTimer();
-
-  // Call/await the request handler that the middleware wraps here.
+const myApilyticsMiddleware = async (req, handler) => {
+  const apiKey = process.env.APILYTICS_API_KEY;
+  if (!apiKey) {
+    return await handler(req);
+  }
 
+  const timer = milliSecondTimer();
+  const res = await handler(req);
   sendApilyticsMetrics({
-    apiKey: process.env.APILYTICS_API_KEY,
+    apiKey,
     path: req.path,
     method: req.method,
     statusCode: res.statusCode,
     timeMillis: timer(),
   });
+  return res;
 };
 ```
 

packages/express/README.md

@@ -8,6 +8,8 @@
 [![node versions](https://img.shields.io/node/v/@apilytics/express)](#what-nodejs-versions-does-the-package-work-with)
 [![license](https://img.shields.io/npm/l/@apilytics/express)](https://github.com/apilytics/apilytics-node/blob/master/packages/express/LICENSE)
 
+Apilytics is a service that lets you analyze operational, performance and security metrics from your APIs without infrastructure-level logging.
+
 ## Installation
 
 1. Sign up and get your API key from https://apilytics.io - we offer a completely free trial with no credit card required!

packages/express/src/index.ts

@@ -1,6 +1,5 @@
 import { milliSecondTimer, sendApilyticsMetrics } from '@apilytics/core';
-import type { NextFunction, Request, Response } from 'express';
-import type { RequestHandler } from 'express-serve-static-core';
+import type { NextFunction, Request, RequestHandler, Response } from 'express';
 
 export const apilyticsMiddleware = (
   apiKey: string | undefined,
@@ -13,7 +12,6 @@ export const apilyticsMiddleware = (
 
   return (req: Request, res: Response, next: NextFunction): void => {
     const timer = milliSecondTimer();
-
     res.on('finish', () => {
       sendApilyticsMetrics({
         apiKey,
@@ -23,7 +21,6 @@ export const apilyticsMiddleware = (
         timeMillis: timer(),
       });
     });
-
     next();
   };
 };

packages/next/README.md

@@ -8,6 +8,8 @@
 [![node versions](https://img.shields.io/node/v/@apilytics/next)](#what-nodejs-versions-does-the-package-work-with)
 [![license](https://img.shields.io/npm/l/@apilytics/next)](https://github.com/apilytics/apilytics-node/blob/master/packages/next/LICENSE)
 
+Apilytics is a service that lets you analyze operational, performance and security metrics from your APIs without infrastructure-level logging.
+
 ## Installation
 
 1. Sign up and get your API key from https://apilytics.io - we offer a completely free trial with no credit card required!