Skip to content

Commit bc0a4e5

Browse files
authored
Update the README.md according to the 1.4 version (#33)
1 parent f6d8a29 commit bc0a4e5

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,11 @@
2222

2323
## Project description
2424
Souin is a new cache system suitable for every reverse-proxy. It will be placed on top of your current reverse-proxy whether it's Apache, Nginx or Traefik.
25-
As it's written in go, it can be deployed on any server and thanks to the docker integration, it will be easy to install on top of a Swarm, or a kubernetes instance.
25+
As it's written in go, it can be deployed on any server and thanks to the docker integration, it will be easy to install on top of a Swarm, or a kubernetes instance.
26+
It's RFC compatible, supporting Vary, request coalescing and other specifications related to the [RFC-7234](https://tools.ietf.org/html/rfc7234)
2627

2728
## Disclaimer
28-
If you don't need redis or other custom cache providers, it's recommended to use the minimal version. You can read the documentation, on [the master branch](https://github.com/darkweak/souin).
29+
If you need redis or other custom cache providers, you have to use the full-featured version. You can read the documentation, on [the full-featured branch](https://github.com/Darkweak/Souin/pull/30) to discover the specific parts.
2930

3031
## Configuration
3132
The configuration file is stored at `/anywhere/configuration.yml`. You can edit it provided you fill at least the required parameters as shown below.

0 commit comments

Comments
 (0)