Skip to content

Commit 1c4e254

Browse files
authored
docs: cleanup readme
1 parent 2328348 commit 1c4e254

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ in the cache, and serves it to the client. This approach reduces direct database
2121
- [Use Cases](#use-cases)
2222
- [Installation](#installation)
2323
- [Get Started](#get-started)
24-
- [DataSource](#1-datasource)
25-
- [Keyspace](#2-keyspace)
24+
- [DataSource](#datasource)
25+
- [Keyspace](#keyspace)
2626

2727
## Features
2828

@@ -67,9 +67,9 @@ go get github.com/tochemey/distcache
6767

6868
## Get Started
6969

70-
To integrate `DistCache` into your project, one only need to implement two key interfaces that are needed in the [Config](./config.go) to start the `DistCache` [Engine](./engine.go).
70+
To integrate `DistCache` into your project, one only need to implement `two key interfaces` that are needed in the [Config](./config.go) to start the `DistCache` [Engine](./engine.go).
7171

72-
### 1. DataSource
72+
### DataSource
7373

7474
The [DataSource](./datasource.go) interface tells `DistCache` where to fetch data from when a cache miss occurs. This could be any external source such as a database, an API, or even a file system.
7575

@@ -90,7 +90,8 @@ func (ds *MyDataSource) Fetch(ctx context.Context, key string) ([]byte, error) {
9090
}
9191
````
9292

93-
### 2. KeySpace
93+
### KeySpace
94+
9495
The [KeySpace](./keyspace.go) interface defines a `logical namespace for grouping` key/value pairs. It provides metadata such as the namespace's name, storage limits, and expiration logic for keys.
9596
KeySpaces are loaded during `DistCache` bootstrap.
9697

0 commit comments

Comments
 (0)