ef5fdfb9a88ef910aca57c92226347f261ef7418 — Rômulo Alves 4 years ago 34cf02e
Improving README about cache
1 files changed, 13 insertions(+), 0 deletions(-)

M README.md => README.md +13 -0
@@ 22,6 22,19 @@ Access the service with the user in the end of the url:

Example: [http://localhost:3000/romuloaalves](http://localhost:3000/romuloaalves)

#### Cache
This service has a cache that is _DISABLED_ by default. To enable it, follow the steps below:

To enable the cache, set the environment variable `USE_CACHE` to `true`.

Use can use more environment variables to cache requests, they are below:

- `CACHE_DIR`: (String, Default: `/tmp`) Directory where Cache files will be included;
- `CACHE_LIFETIME`: (Number, Minutes, Default: `60`) How much time the cache is valid.

If the cache is active, you can use the parameter `?cache=false` in the url to ignore cache verification.

## License

MIT License