From ce566e078c85e30cb6fe597343afe9665e680743 Mon Sep 17 00:00:00 2001 From: Fenny <25108519+Fenny@users.noreply.github.com> Date: Mon, 23 Nov 2020 09:38:29 +0100 Subject: [PATCH 1/2] =?UTF-8?q?=E2=9C=8F=20update=20readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 35 +++++++++++++++++++++++++++-------- 1 file changed, 27 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index de7e050b..2994b041 100644 --- a/README.md +++ b/README.md @@ -21,16 +21,39 @@

-Premade storage drivers that implement [`Storage`](https://github.com/gofiber/storage/blob/main/storage.go) interface, designed 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) -* [DynamoDB](/dynamodb) - - * [Memcache](/memcache) @@ -52,7 +75,3 @@ Premade storage drivers that implement [`Storage`](https://github.com/gofiber/st * [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? From 3058c5ea7b8c20f1167556657c9ae492d64d4a2f Mon Sep 17 00:00:00 2001 From: Fenny <25108519+Fenny@users.noreply.github.com> Date: Mon, 23 Nov 2020 09:39:39 +0100 Subject: [PATCH 2/2] =?UTF-8?q?=E2=9C=8F=20update=20readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/README.md | 33 ++++++++++++++++---- README.md | 77 ----------------------------------------------- 2 files changed, 27 insertions(+), 83 deletions(-) delete mode 100644 README.md 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 2994b041..00000000 --- a/README.md +++ /dev/null @@ -1,77 +0,0 @@ - -

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

- -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) - - -* [Memcache](/memcache) - - -* [Memory](/memory) - - -* [MongoDB](/mongodb) - - -* [MySQL](/mysql) - - -* [Postgres](/postgres) - - -* [Redis](/redis) - - -* [SQLite3](/sqlite3) - -