diff --git a/.github/README.md b/.github/README.md index 4b56576f..2994b041 100644 --- a/.github/README.md +++ b/.github/README.md @@ -21,11 +21,36 @@

-Premade storage drivers that implement [`fiber.Storage`](https://github.com/gofiber/fiber/blob/ba08653c92f86bc69956b23714f919b705d9381e/app.go#L39-L50), to be used with various Fiber middlewares. +Premade storage drivers that implement the [`Storage`](https://github.com/gofiber/storage/blob/main/storage.go) interface, designed to be used with various [Fiber middlewares](https://github.com/gofiber/fiber/tree/master/middleware). + +```go +// Storage interface for communicating with different database/key-value +// providers. Visit https://github.com/gofiber/storage for more info. +type Storage interface { + // Get gets the value for the given key. + // `nil, nil` is returned when the key does not exist + Get(key string) ([]byte, error) + + // Set stores the given value for the given key along + // with an expiration value, 0 means no expiration. + // Empty key or value will be ignored without an error. + Set(key string, val []byte, exp time.Duration) error + + // Delete deletes the value for the given key. + // It returns no error if the storage does not contain the key, + Delete(key string) error + + // Reset resets the storage and delete all keys. + Reset() error + + // Close closes the storage and will stop any running garbage + // collectors and open connections. + Close() error +} +``` ## 📑 Storage Implementations - * [Badger](/badger) @@ -50,7 +75,3 @@ Premade storage drivers that implement [`fiber.Storage`](https://github.com/gofi * [SQLite3](/sqlite3) - -## 🤔 Something missing? - -If you've got a custom storage driver you made that's not listed here, why not submit a [PR](https://github.com/gofiber/storage/pulls) to add it? diff --git a/README.md b/README.md deleted file mode 100644 index de7e050b..00000000 --- a/README.md +++ /dev/null @@ -1,58 +0,0 @@ - -

- - - # 📦 Storage - - - - - - - - - - - - - -

- -Premade storage drivers that implement [`Storage`](https://github.com/gofiber/storage/blob/main/storage.go) interface, designed to be used with various Fiber middlewares. - -## 📑 Storage Implementations - -* [Badger](/badger) - - -* [DynamoDB](/dynamodb) - - -* [Memcache](/memcache) - - -* [Memory](/memory) - - -* [MongoDB](/mongodb) - - -* [MySQL](/mysql) - - -* [Postgres](/postgres) - - -* [Redis](/redis) - - -* [SQLite3](/sqlite3) - - - -## 🤔 Something missing? - -If you've got a custom storage driver you made that's not listed here, why not submit a [PR](https://github.com/gofiber/storage/pulls) to add it?