-
Notifications
You must be signed in to change notification settings - Fork 70
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Document DragonflyDB support #1564
Changes from 3 commits
951bb77
4e570ad
a7c7b42
10e473e
c00f649
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,6 +6,8 @@ import ( | |
) | ||
|
||
// Config defines the config for storage. | ||
// | ||
// Dragonfly and Redis share the same config | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I dont think we need this new comments here. The ones in the README are enough. |
||
type Config struct { | ||
// Host name where the DB is hosted | ||
// | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,7 +13,11 @@ type Storage struct { | |
db redis.UniversalClient | ||
} | ||
|
||
// New creates a new redis storage | ||
// New creates a new Redis storage instance. | ||
// | ||
// DragonflyDB is fully compatible with the Redis API, meaning it can be used as a drop-in replacement for Redis. | ||
// | ||
// Because of this compatibility, DragonflyDB can also be initialized through this function. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I dont think we need this new comments here. The ones in the README are enough. |
||
func New(config ...Config) *Storage { | ||
// Set default config | ||
cfg := configDefault(config...) | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove trailing spaces.