Skip to content

Commit f984c86

Browse files
committed
README: fold install into getting started
1 parent 8be6c40 commit f984c86

File tree

3 files changed

+13
-15
lines changed

3 files changed

+13
-15
lines changed

README.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,15 @@
77

88
SAP BTP feature toggle library enables Node.js applications using the SAP Cloud Application Programming Model to maintain live-updatable feature toggles via Redis.
99

10-
## Install or Upgrade
11-
12-
```bash
13-
npm install --save @cap-js-community/feature-toggle-library
14-
```
15-
1610
## Getting Started
1711

1812
- Set up project with `@sap/cds`
19-
- Install library `npm install --save @cap-js-community/feature-toggle-library`
13+
- Install library
14+
15+
```bash
16+
npm install --save @cap-js-community/feature-toggle-library
17+
```
18+
2019
- Write `toggles.yaml` configuration file:
2120

2221
```yaml

docs/index.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,15 @@ nav_order: 1
88

99
SAP BTP feature toggle library enables Node.js applications using the SAP Cloud Application Programming Model to maintain live-updatable feature toggles via Redis.
1010

11-
## Install or Upgrade
12-
13-
```bash
14-
npm install --save @cap-js-community/feature-toggle-library
15-
```
16-
1711
## Getting Started
1812

1913
- Set up project with `@sap/cds`
20-
- Install library `npm install --save @cap-js-community/feature-toggle-library`
14+
- Install library
15+
16+
```bash
17+
npm install --save @cap-js-community/feature-toggle-library
18+
```
19+
2120
- Write `toggles.yaml` configuration file:
2221

2322
```yaml

test/docs.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ const { join } = require("path");
55

66
describe("docs", () => {
77
it("documentation README / overview consistency check", async () => {
8-
const headings = ["Install or Upgrade", "Getting Started", "Features", "Peers"];
8+
const headings = ["Getting Started", "Features", "Peers"];
99
const readmeData = readFileSync(join(__dirname, "..", "README.md")).toString();
1010
const overviewData = readFileSync(join(__dirname, "..", "docs", "index.md")).toString();
1111
for (const heading of headings) {

0 commit comments

Comments
 (0)