Merge pull request #5 from mojaloop/task/csi-162

chore: added redis impl.

.circleci/config.yml

@@ -51,13 +51,11 @@ defaults_npm_auth: &defaults_npm_auth
 
 defaults_npm_publish_release: &defaults_npm_publish_release
   name: Publish NPM $RELEASE_TAG artifact
-  command: |
+  command: |   
     source $BASH_ENV
     npm ci
     echo "Publishing tag $RELEASE_TAG"
     npm publish --tag $RELEASE_TAG --access public
-    echo $(node -p "require('./package.json').name")
-    npm dist-tag add @mojaloop/inter-scheme-proxy-cache-lib@$RELEASE_TAG latest
 
 defaults_export_version_from_package: &defaults_export_version_from_package
   name: Format the changelog into the github release body and get release tag

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+### [0.3.3](https://github.com/mojaloop/inter-scheme-proxy-cache-lib/compare/v0.3.2...v0.3.3) (2024-06-26)
+
+
+### Chore
+
+* **csi-162:** added BasicProxyCache; hid logger-related types; updated docs ([c3fe557](https://github.com/mojaloop/inter-scheme-proxy-cache-lib/commit/c3fe557a805579d638298401acc5bce23ae9d810))
+
+### [0.3.2](https://github.com/mojaloop/inter-scheme-proxy-cache-lib/compare/v0.3.1-snapshot.1...v0.3.2) (2024-06-26)
+
+
+### Chore
+
+* **csi-162:** updated deps ([20b959f](https://github.com/mojaloop/inter-scheme-proxy-cache-lib/commit/20b959fe72967ddb7fb0a068ae6d178c2755ebbf))

README.md

@@ -24,33 +24,24 @@ import { createProxyCache, STORAGE_TYPES } from '@mojaloop/inter-scheme-proxy-ca
 const { createProxyCache } = require('@mojaloop/inter-scheme-proxy-cache-lib');
 
 const proxyCache = createProxyCache(STORAGE_TYPES.redis, { 
-  host: localhost,
+  host: 'localhost',
   port: 6379,
   ...
 });
-// todo: define usefull example
 await proxyCache.addDfspIdToProxyMapping('dfsp_1', 'proxyAB');
 ```
 
-### TypeDoc
-Comprehensive and interactive documentation, based on TypeScript source code of the package,
-could be found [**here**](https://mojaloop.github.io/inter-scheme-proxy-cache-lib)
-
+### API docs
+Check [_IProxyCache_](https://mojaloop.github.io/inter-scheme-proxy-cache-lib/interfaces/IProxyCache.html) interface docs to get more details.
 
-### API
-```typescript
- addDfspIdToProxyMapping: (dfspId: string, proxyId: string) => Promise<boolean>;
- // Add the proxyAdapter details of a particular DFSP to proxy mapping
+Comprehensive and interactive API documentation, based on TypeScript source code of the package,
+could be found [**here**](https://mojaloop.github.io/inter-scheme-proxy-cache-lib)
 
- ...
- // todo: add all methods
-```
 
 ### Environment Variables
-| Env Variable Name           | Default Value | Description | 
-|-----------------------------|---------------|-------------|
-| LOG_LEVEL_PROXY_CACHE       | `warn`        | The log level for the proxy cache | <!-- white -->
-| todo: add required env vars |  |  | 
+| Env Variable Name           | Default Value | Description                        | 
+|-----------------------------|---------------|------------------------------------|
+| LOG_LEVEL_PROXY_CACHE       | `warn`        | The log level for the proxyCache |
 
 
 
@@ -70,6 +61,12 @@ npm run build
 npm test
 ```
 
+### Generate Typedoc documentation
+
+```bash
+npm run docs
+```
+
 ## Collaborators
 
 - [Eugen Klymniuk](https://github.com/geka-evk)