Skip to content

Commit 2fb5a34

Browse files
Feat/hide readme (#66)
1 parent c9edddb commit 2fb5a34

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

README.md

+19-5
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,9 @@ ffclient.Init(ffclient.Config{
9696
We can have only one source for the file, if you set multiple sources in your configuration, only one will be take in
9797
consideration.
9898

99-
### From GitHub
99+
<details>
100+
<summary><span style="font-size: 1.2em;font-style: bold;">From GitHub</span> <span style="font-size:0.8em;font-style: italic;">(click to see details)</span></summary>
101+
100102
```go
101103
err := ffclient.Init(ffclient.Config{
102104
PollInterval: 3,
@@ -119,7 +121,11 @@ To configure the access to your GitHub file:
119121

120122
:warning: GitHub has rate limits, so be sure to not reach them when setting your `PollInterval`.
121123

122-
### From an HTTP endpoint
124+
</details>
125+
126+
<details>
127+
<summary><span style="font-size: 1.2em;font-style: bold;">From an HTTP endpoint</span> <span style="font-size:0.8em;font-style: italic;">(click to see details)</span></summary>
128+
123129
```go
124130
err := ffclient.Init(ffclient.Config{
125131
PollInterval: 3,
@@ -138,7 +144,11 @@ To configure your HTTP endpoint:
138144
- **Header**: Header you should pass while calling the endpoint *(useful for authorization)*.
139145
- **Timeout**: Timeout for the HTTP call (default is 10 seconds).
140146

141-
### From a S3 Bucket
147+
</details>
148+
149+
<details>
150+
<summary><span style="font-size: 1.2em;font-style: bold;">From a S3 Bucket</span> <span style="font-size:0.8em;font-style: italic;">(click to see details)</span></summary>
151+
142152
```go
143153
err := ffclient.Init(ffclient.Config{
144154
PollInterval: 3,
@@ -158,7 +168,11 @@ To configure your S3 file location:
158168
- **Item**: The location of your file in the bucket. **MANDATORY**
159169
- **AwsConfig**: An instance of `aws.Config` that configure your access to AWS *(see [this documentation for more info](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html))*. **MANDATORY**
160170

161-
### From a file
171+
</details>
172+
173+
<details>
174+
<summary><span style="font-size: 1.2em;font-style: bold;">From a file</span> <span style="font-size:0.8em;font-style: italic;">(click to see details)</span></summary>
175+
162176
```go
163177
err := ffclient.Init(ffclient.Config{
164178
PollInterval: 3,
@@ -173,7 +187,7 @@ To configure your File retriever:
173187
- **Path**: location of your file. **MANDATORY**
174188

175189
*I will not recommend using a file to store your flags except if it is in a shared folder for all your services.*
176-
190+
</details>
177191

178192
## Flags file format
179193
`go-feature-flag` is to avoid to have to host a backend to manage your feature flags and to keep them centralized by using a file a source.

0 commit comments

Comments
 (0)