From ad21314ce8298a61667264ce8afc99c7d2f6452c Mon Sep 17 00:00:00 2001
From: temz <artem.rusanov.02@gmail.com>
Date: Wed, 24 Nov 2021 14:16:34 +0700
Subject: [PATCH] feat: add docs

---
 README.md | 153 ++----------------------------------------------------
 1 file changed, 3 insertions(+), 150 deletions(-)

diff --git a/README.md b/README.md
index 48d1902..69adf0d 100644
--- a/README.md
+++ b/README.md
@@ -1,162 +1,15 @@
-# Logardian
+# NestJS Response Structure
 
-Inspired by NestJS Logger, Logardian was built to output minimalistic, readable logs.
+GraphQL Types and interfaces for great response
 
-## Roadmap
-
-- Logging to file
-
-  
 ## Installation
 
 Requires node version >=12.х
 
 ```bash
-npm i --save logardian
-```
-    
-## Features
-
-- Various layers of logs that can be turned on/off via .env (`LOGARDIAN_LABELS`)
-- In production mode debug() does not work
-- Datetime in UTC format
-- Format of logs: `[time] [level] [layer] [message]`
-- In debug mode the path and name of the function that called the log is displayed
-- Can be used instead of NestJS Logger
-- Can log any objects, arrays, variables
-- Modes: normal or json format output
-- Colors!
-
-  
-## Usage/Examples
-
-```ts
-import Logardian from 'logardian'
-
-const logger = new Logardian()
-
-logger.configure({
-    trace: false
-})
-
-logger.log(`Hi! I'm info log example`)
-logger.warn(`Hi! I'm warn log example`, { trace: false })
-logger.error(`Hi! I'm error log example`)
-logger.verbose(`Hi! I'm verbose log example`, { label: 'database' })
-logger.debug(`Hi! I'm debug log example`, { some: 'object' })
-```
-
-***default output:***
-
-![](https://i.ibb.co/0nRH2Yc/photo-2021-11-05-12-52-51.jpg)
-
-
-***json output:***
-
-```ts
-logger.configure({
-    json: true
-})
-```
-
-```bash
-{
-  "timestamp": "2021-11-05T05:54:10.920Z",
-  "message": "Hi! I'm info log example",
-  "level": "log"
-}
-{
-  "timestamp": "2021-11-05T05:54:10.920Z",
-  "message": "Hi! I'm warn log example",
-  "level": "warn"
-}
-{
-  "timestamp": "2021-11-05T05:54:10.920Z",
-  "message": "Hi! I'm error log example",
-  "level": "error"
-}
-{
-  "timestamp": "2021-11-05T05:54:10.920Z",
-  "message": "Hi! I'm verbose log example",
-  "level": "verbose",
-  "label": "database"
-}
-{
-  "timestamp": "2021-11-05T05:54:10.920Z",
-  "message": "{\n  \"some\": \"object\"\n}",
-  "level": "debug"
-}
-```
-
-## Environment Variables
-
-`NODE_ENV` production start does not show debug() logs
-
-## FAQ
-
-#### How does it implement NestJS Logger without any framework libs?
-
-We made logger based on [LoggerService](https://github.com/nestjs/nest/blob/master/packages/common/services/logger.service.ts) but we don't explicitly import it so that we stay dependless of NestJS libraries. But you can also use the Logardian instead of common NestJS logger.
-
-```ts
-// main.ts
-import { Logardian } from 'logardian'
-
-const logger = new Logardian()
-
-async function bootstrap(): Promise<void> {
-    const app = await NestFactory.create(AppModule, { logger })
-
-    await app.listen(port, hostname, () =>
-        logger.log(`Server running at ${hostname}:${port}`),
-    )
-}
-```
-
-#### How can I use logardian in my service?
-
-Simply create a new logger class
-
-```ts
-import { Logardian } from 'logardian'
-
-@Injectable()
-export class CatService {
-    private readonly _logger = new Logardian()
-}
+npm i --save nestjs-response-structure
 ```
 
-#### I do not see my logs with label
-
-Specify labels you want to log or write `*` to log every log with label. 
-Working in production and development mode
-
-Logardian is a singleton, so it means that `configure()` works on all Logardian instances
-
-```ts
-import { Logardian } from 'logardian'
-
-const logger = new Logardian()
-
-logger.configure({
-    labels: '*' // or ['database', 'events'] or false
-    trace: false,
-    json: true
-})
-```
-
-#### I do not want to see caller and path. How can I turn off them globally?
-
-Specify 'false' on logardian config. If you specify `trace: true` in logger function trace will log in spite of config option
-
-Priority of trace from high to low:
-
-1. Production mode
-2. `logger.log('Hello', { trace: true })`
-3. `logger.configure({ trace: false })`
-
-
-
 ## License