Skip to content

Commit ee52da9

Browse files
authored
docs(angular): improve angular readme layout (#1013)
Signed-off-by: Michael Beemer <[email protected]>
1 parent 8bdc164 commit ee52da9

File tree

1 file changed

+32
-16
lines changed
  • packages/angular/projects/angular-sdk

1 file changed

+32
-16
lines changed

Diff for: packages/angular/projects/angular-sdk/README.md

+32-16
Original file line numberDiff line numberDiff line change
@@ -40,23 +40,27 @@ for feature flagging that works with your favorite feature flag management tool
4040
The OpenFeature Angular SDK adds Angular-specific functionality to
4141
the [OpenFeature Web SDK](https://openfeature.dev/docs/reference/technologies/client/web).
4242

43-
## Table of Contents
43+
In addition to the features provided by the [web sdk](https://openfeature.dev/docs/reference/technologies/client/web), capabilities include:
4444

45+
- [Overview](#overview)
4546
- [Quick start](#quick-start)
46-
- [Requirements](#requirements)
47-
- [Install](#install)
48-
- [npm](#npm)
49-
- [yarn](#yarn)
50-
- [Required peer dependencies](#required-peer-dependencies)
51-
- [Minimal Example](#minimal-example)
52-
- [Flag Types](#flag-types)
53-
- [Boolean Feature Flag](#boolean-feature-flag)
54-
- [Number Feature Flag](#number-feature-flag)
55-
- [String Feature Flag](#string-feature-flag)
56-
- [Object Feature Flag](#object-feature-flag)
57-
- [Inputs](#inputs)
58-
- [Contributing](#contributing)
59-
- [License](#license)
47+
- [Requirements](#requirements)
48+
- [Install](#install)
49+
- [npm](#npm)
50+
- [yarn](#yarn)
51+
- [Required peer dependencies](#required-peer-dependencies)
52+
- [Usage](#usage)
53+
- [Module](#module)
54+
- [Minimal Example](#minimal-example)
55+
- [How to use](#how-to-use)
56+
- [Boolean Feature Flag](#boolean-feature-flag)
57+
- [Number Feature Flag](#number-feature-flag)
58+
- [String Feature Flag](#string-feature-flag)
59+
- [Object Feature Flag](#object-feature-flag)
60+
- [Opting-out of automatic re-rendering](#opting-out-of-automatic-re-rendering)
61+
- [Consuming the evaluation details](#consuming-the-evaluation-details)
62+
- [FAQ and troubleshooting](#faq-and-troubleshooting)
63+
- [Resources](#resources)
6064

6165
## Quick start
6266

@@ -89,7 +93,7 @@ See the [package.json](./package.json) for the required versions.
8993
* `@angular/common`
9094
* `@angular/core`
9195

92-
#### Usage
96+
### Usage
9397

9498
#### Module
9599

@@ -276,3 +280,15 @@ This can be used to just render the flag value or details without conditional re
276280
The theme color is {{ value }}.
277281
</div>
278282
```
283+
284+
## FAQ and troubleshooting
285+
286+
> I can import things form the `@openfeature/angular-sdk`, `@openfeature/web-sdk`, and `@openfeature/core`; which should I use?
287+
288+
The `@openfeature/angular-sdk` re-exports everything from its peers (`@openfeature/web-sdk` and `@openfeature/core`), and adds the Angular-specific features.
289+
You can import everything from the `@openfeature/angular-sdk` directly.
290+
Avoid importing anything from `@openfeature/web-sdk` or `@openfeature/core`.
291+
292+
## Resources
293+
294+
- [Example repo](https://github.com/open-feature/angular-test-app)

0 commit comments

Comments
 (0)