Skip to content

Commit

Permalink
README: fold install into getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
rlindner81 committed Dec 5, 2023
1 parent 8be6c40 commit f984c86
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 15 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,15 @@

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

## Install or Upgrade

```bash
npm install --save @cap-js-community/feature-toggle-library
```

## Getting Started

- Set up project with `@sap/cds`
- Install library `npm install --save @cap-js-community/feature-toggle-library`
- Install library

```bash
npm install --save @cap-js-community/feature-toggle-library
```

- Write `toggles.yaml` configuration file:

```yaml
Expand Down
13 changes: 6 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,15 @@ nav_order: 1

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

## Install or Upgrade

```bash
npm install --save @cap-js-community/feature-toggle-library
```

## Getting Started

- Set up project with `@sap/cds`
- Install library `npm install --save @cap-js-community/feature-toggle-library`
- Install library

```bash
npm install --save @cap-js-community/feature-toggle-library
```

- Write `toggles.yaml` configuration file:

```yaml
Expand Down
2 changes: 1 addition & 1 deletion test/docs.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ const { join } = require("path");

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

0 comments on commit f984c86

Please sign in to comment.