usage examples for readme

Author: shalarewicz

README.md

@@ -7,9 +7,9 @@
    </div>
 
 &nbsp;
-## Summary 
+## Summary
 
-Developed under tech-accelerator [OSLabs](https://opensourcelabs.io/), GraphQLGate strives for a principled approach to complexity analysis and rate-limiting for GraphQL queries by accurately estimating an upper-bound of the response size of the query. Within a loosely opinionated framework with lots of configuration options, you can reliably throttle GraphQL queries by complexity and depth to protect your GraphQL API. Our solution is inspired by [this paper](https://github.com/Alan-Cha/fse20/blob/master/submissions/functional/FSE-24/graphql-paper.pdf) from IBM research teams. 
+Developed under tech-accelerator [OSLabs](https://opensourcelabs.io/), GraphQLGate strives for a principled approach to complexity analysis and rate-limiting for GraphQL queries by accurately estimating an upper-bound of the response size of the query. Within a loosely opinionated framework with lots of configuration options, you can reliably throttle GraphQL queries by complexity and depth to protect your GraphQL API. Our solution is inspired by [this paper](https://github.com/Alan-Cha/fse20/blob/master/submissions/functional/FSE-24/graphql-paper.pdf) from IBM research teams.
 
 ## Table of Contents
 
@@ -201,29 +201,79 @@ This package exposes 3 additional functionalities which comprise the internals o
 
 ### Complexity Analysis
 
-1. #### `typeWeightsFromSchema` | create the type weight object from the schema for complexity analysis
-   - `schema: GraphQLSchema` | GraphQL schema object
-   - `typeWeightsConfig: TypeWeightConfig = defaultTypeWeightsConfig` | type weight configuration
-   - `enforceBoundedLists = false` 
-   - returns: `TypeWeightObject`  
+1. #### `typeWeightsFromSchema` | function to create the type weight object from the schema for complexity analysis
 
-2. #### `ComplexityAnalysis` | calculate the complexity of the query based on the type weights and variables
-   - `typeWeights: TypeWeightObject`
-   - `variables: Variables` | variables on request
-   - returns a class with method:
-      - `processQuery(queryAST: DocumentNode): number`
-      - returns: complexity of the query and exposes `maxDepth` property for depth limiting
+    - `schema: GraphQLSchema` | GraphQL schema object
+    - `typeWeightsConfig: TypeWeightConfig = defaultTypeWeightsConfig` | type weight configuration
+    - `enforceBoundedLists = false`
+    - returns: `TypeWeightObject`
+    - usage:
+
+        ```ts
+        import { typeWeightsFromSchema } from 'graphql-limiter';
+        import { GraphQLSchema } from 'graphql/type/schema';
+
+        let schema: GraphQLSchema = buildSchema(`...`);
+
+        const typeWeights: TypeWeightObject = typeWeightsFromSchema(schema);
+        ```
+
+2. #### `ComplexityAnalysis` | class to calculate the complexity of the query based on the type weights and variables
+
+    - `typeWeights: TypeWeightObject`
+    - `variables: Variables` | variables on request
+    - returns a class with method:
+
+        - `processQuery(queryAST: DocumentNode): number`
+        - returns: complexity of the query and exposes `maxDepth` property for depth limiting
+        - usage:
+
+            ```ts
+            import { typeWeightsFromSchema } from 'graphql-limiter';
+            import { parse } from 'graphql';
+
+            let query: DocumentNode = parse(`...`);
+
+            const queryParser: ASTParser = new ComplexityAnalysis(typeWeights, variables);
+
+            const complexity: number = queryParser.parse(query);
+            ```
 
 ### Rate-limiting
 
-3. #### `rateLimiter` | returns a rate limiting implementation based on selections
-   - `rateLimiter: RateLimiterConfig` | see "configuration" -> rateLimiter
-   - `client: Redis` | an ioredis client
-   - `keyExpiry: number` | time (ms) for key to persist in cache
-   - returns a class with method:
-      - `processRequest(uuid: string, timestamp: number, tokens = 1): Promise<RateLimiterResponse>`
-      - returns: `{ success: boolean, tokens: number, retryAfter?: number }` | where tokens is tokens available, retryAfter is time to wait in seconds before the request would be successful and success is false if the request is blocked
+3. #### `rateLimiter` | returns a rate limiting class instance based on selections
+
+    - `rateLimiter: RateLimiterConfig` | see "configuration" -> rateLimiter
+    - `client: Redis` | an ioredis client
+    - `keyExpiry: number` | time (ms) for key to persist in cache
+    - returns a class with method:
+
+        - `processRequest(uuid: string, timestamp: number, tokens = 1): Promise<RateLimiterResponse>`
+        - returns: `{ success: boolean, tokens: number, retryAfter?: number }` | where tokens is tokens available, retryAfter is time to wait in seconds before the request would be successful and success is false if the request is blocked
+
+        usage:
+
+        ```ts
+        import { rateLimiter } from 'graphql-limiter';
+
+        const limiter: RateLimiter = rateLimiter(
+            {
+                type: 'TOKEN_BUCKET',
+                refillRate: 1,
+                capacity: 10,
+            },
+            typeWeights,
+            true
+        );
+
+        const response: RateLimiterResponse = limiter.processRequest(
+            'user-1',
+            new Date().valueOf(),
+            5
+        );
 
+        const complexity: number = queryParser.parse(query);
+        ```
 
 ## <a name="future-development"></a> Future Development