fix(documentation): write README and lint Caddyfiles + fix Makefiles

.github/workflows/static.yml

@@ -10,13 +10,14 @@ env:
 jobs:
   static-validation:
     services:
-      nats:
-        image: nats
-        command: -js
-        ports:
-          - 4222:4222
-          - 6222:6222
-          - 8222:8222
+      # nats:
+      #   image: nats
+      #   volumes:
+      #     - ${{ github.workspace }}/.github/workflows/nats.conf:/etc/nats/nats-server.conf
+      #   ports:
+      #     - 4222:4222
+      #     - 6222:6222
+      #     - 8222:8222
       redis:
         image: redis
         ports:
@@ -43,7 +44,7 @@ jobs:
           - core
           - etcd
           - go-redis
-          - nats
+          # - nats
           - nuts
           - otter
           - redis

README.md

@@ -3,3 +3,13 @@
 This repository contains all supported storages by the HTTP cache [Souin](https://github.com/darkweak/souin).  
 Each storages are available as caddy module and can be used with the HTTP cache module.  
 Using caddy, you can build your instance using the following template `xcaddy build --with github.com/darkweak/storages/{your_storage}/caddy`.
+
+## Supported storages
+* [Badger](https://github.com/dgraph-io/badger)
+* [Etcd](https://github.com/etcd-io/etcd)
+* [Go-redis](https://github.com/redis/go-redis)
+* [Nats](https://github.com/nats-io/nats-server)
+* [Nuts](https://github.com/nutsdb/nutsdb)
+* [Olric](https://github.com/buraksezer/olric)
+* [Otter](https://github.com/maypok86/otter)
+* [Redis](https://github.com/redis/rueidis)

badger/caddy/Caddyfile

@@ -17,4 +17,4 @@ http://localhost {
             }
         }
     }
-}
+}

etcd/caddy/Caddyfile

@@ -17,4 +17,4 @@ http://localhost {
             }
         }
     }
-}
+}

go-redis/caddy/Caddyfile

@@ -17,4 +17,4 @@ http://localhost {
             }
         }
     }
-}
+}

go-redis/caddy/Makefile

@@ -3,5 +3,5 @@
 build:
 	go mod tidy
 	go mod download
-	XCADDY_RACE_DETECTOR=1 XCADDY_DEBUG=1 xcaddy build --with github.com/darkweak/storages/core=../../core/ --with github.com/darkweak/storages/redis=../ --with github.com/darkweak/storages/redis/caddy=./
-	./caddy run
+	XCADDY_RACE_DETECTOR=1 XCADDY_DEBUG=1 xcaddy build --with github.com/darkweak/storages/core=../../core/ --with github.com/darkweak/storages/go-redis=../ --with github.com/darkweak/storages/go-redis/caddy=./
+	./caddy run

nats/caddy/Caddyfile

@@ -17,4 +17,4 @@ http://localhost {
             }
         }
     }
-}
+}

nats/caddy/Makefile

@@ -3,5 +3,5 @@
 build:
 	go mod tidy
 	go mod download
-	XCADDY_RACE_DETECTOR=1 XCADDY_DEBUG=1 xcaddy build --with github.com/darkweak/storages/core=../../core/ --with github.com/darkweak/storages/otter=../ --with github.com/darkweak/storages/otter/caddy=./
+	XCADDY_RACE_DETECTOR=1 XCADDY_DEBUG=1 xcaddy build --with github.com/darkweak/storages/core=../../core/ --with github.com/darkweak/storages/nats=../ --with github.com/darkweak/storages/nats/caddy=./
 	./caddy run

nuts/caddy/Caddyfile

@@ -17,4 +17,4 @@ http://localhost {
             }
         }
     }
-}
+}

olric/caddy/Caddyfile

@@ -15,4 +15,4 @@ http://localhost {
             olric
         }
     }
-}
+}

otter/caddy/Caddyfile

@@ -17,4 +17,4 @@ http://localhost {
             }
         }
     }
-}
+}

redis/caddy/Caddyfile

@@ -17,4 +17,4 @@ http://localhost {
             }
         }
     }
-}
+}