Merge pull request #55 from arkahna/task/FB-133-npm-docs-update

FB-133 npm documentation update
arkahna · Nov 10, 2023 · 0b29c49 · 0b29c49
2 parents 5a6ce9b + 850d83e
commit 0b29c49
Show file tree

Hide file tree

Showing 20 changed files with 98 additions and 53 deletions.
diff --git a/README.md b/README.md
@@ -14,6 +14,10 @@ FeatureBoard Code Generators:
 
 ## What is FeatureBoard?
 
-FeatureBoard is the future of Feature Toggling and is tailored for SaaS teams on the hunt for a simplified yet highly potent feature toggling solution. FeatureBoard enhances team productivity by allowing everyone to manage software features seamlessly, not just developers.
+FeatureBoard is the future of Feature Management and is tailored for SaaS teams on the hunt for a simplified yet highly potent feature toggling solution. FeatureBoard enhances team productivity by allowing everyone to manage software features seamlessly, not just developers.
 
 Go to [our website](https://featureboard.app) to find out more.
+
+## Documentation
+
+Installation and usage instructions can be found on our [docs site](https://docs.featureboard.app).
diff --git a/apps/cli/README.md b/apps/cli/README.md
@@ -1,7 +1,7 @@
-# Featureboard CLI
+# FeatureBoard CLI
 
-CLI tool for interacting with featureboard
+The FeatureBoard Command Line tool.
 
-## Docs
+## Documentation
 
-See https://featureboard.app/docs/cli/getting-started/ for usage instructions and documentation
+See https://docs.featureboard.app/cli/using-the-cli/ for usage instructions and documentation.
diff --git a/apps/cli/package.json b/apps/cli/package.json
@@ -18,7 +18,8 @@
         "url": "git+https://github.com/arkahna/featureboard-sdks.git"
     },
     "keywords": [
-        "Feature toggle",
+        "Feature management",
+        "Feature toggles",
         "Feature flags"
     ],
     "bugs": {

diff --git a/libs/code-generator/README.md b/libs/code-generator/README.md
@@ -1,11 +1,21 @@
-# code-generator
+# FeatureBoard Code Generator
 
-This library was generated with [Nx](https://nx.dev).
+NX tool that generates FeatureBoard SDKs for different languages.
 
-## Building
+![npm](https://img.shields.io/npm/v/%40featureboard%2Fcode-generator?logo=npm) ![npm](https://img.shields.io/npm/dt/%40featureboard%2Fcode-generator?logo=npm) ![GitHub Workflow](https://img.shields.io/github/actions/workflow/status/arkahna/featureboard-sdks/main.yml?logo=github)
 
-Run `nx build code-generator` to build the library.
+## Installation
 
-## Running unit tests
+```bash
+npm add @featureboard/code-generator
+```
+```bash
+yarn add @featureboard/code-generator
+```
+```bash
+pnpm add @featureboard/code-generator
+```
 
-Run `nx test code-generator` to execute the unit tests via Vitest
+## Release Notes
+
+Our changelog can be found on [GitHub](https://github.com/arkahna/featureboard-sdks/blob/main/libs/code-generator/CHANGELOG.md).
diff --git a/libs/code-generator/package.json b/libs/code-generator/package.json
@@ -9,7 +9,8 @@
         "url": "git+https://github.com/arkahna/featureboard-sdks.git"
     },
     "keywords": [
-        "Feature toggle",
+        "Feature management",
+        "Feature toggles",
         "Feature flags"
     ],
     "bugs": {

diff --git a/libs/contracts/README.md b/libs/contracts/README.md
@@ -1,18 +1,20 @@
 # FeatureBoard Contracts
 
-![npm](https://img.shields.io/npm/v/%40featureboard%2Fcontracts?logo=npm) ![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/arkahna/featureboard-sdks/main.yml?logo=github)
+TypeScript type definitions for FeatureBoard SDKs.
+
+![npm](https://img.shields.io/npm/v/%40featureboard%2Fcontracts?logo=npm) ![npm](https://img.shields.io/npm/dt/%40featureboard%2Fcontracts?logo=npm) ![GitHub Workflow](https://img.shields.io/github/actions/workflow/status/arkahna/featureboard-sdks/main.yml?logo=github)
 
-Contains TypeScript type definitions for FeatureBoard SDKs.
 
 ## Installation
 
-The FeatureBoard Contracts is available on NPM.
 
 ```bash
 npm add @featureboard/contracts
-# Or
+```
+```bash
 yarn add @featureboard/contracts
-# Or
+```
+```bash
 pnpm add @featureboard/contracts
 ```
 
@@ -38,4 +40,4 @@ The advantages of using TypeScript type definitions are:
 
 ## Release notes
 
-You can find our [changelog here](/libs/contracts/CHANGELOG.md).
+Our changelog can be found on [Github](https://github.com/arkahna/featureboard-sdks/blob/main/libs/contracts/CHANGELOG.md).
diff --git a/libs/contracts/package.json b/libs/contracts/package.json
@@ -9,7 +9,8 @@
         "url": "git+https://github.com/arkahna/featureboard-sdks.git"
     },
     "keywords": [
-        "Feature toggle",
+        "Feature management",
+        "Feature toggles",
         "Feature flags"
     ],
     "bugs": {

diff --git a/libs/dotnet-sdk/FeatureBoard.DotnetSdk.csproj b/libs/dotnet-sdk/FeatureBoard.DotnetSdk.csproj
@@ -8,7 +8,7 @@
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <Version>0.0.2</Version>
     <PackageDescription>FeatureBoard .NET SDK for .NET core and framework applications.</PackageDescription>
-    <PackageTags>feature toggle flags</PackageTags>
+    <PackageTags>feature toggles flags</PackageTags>
     <Authors>Arkahna</Authors>
     <Copyright>Copyright (c) Arkahna 2023</Copyright>
     <PackageIcon>featureboard-logo.png</PackageIcon>

diff --git a/libs/dotnet-sdk/FeatureBoardHttpClient.cs b/libs/dotnet-sdk/FeatureBoardHttpClient.cs
@@ -42,7 +42,7 @@ public FeatureBoardHttpClient(HttpClient httpClient, LastETagProvider lastModifi
         return false;
 
       case not HttpStatusCode.OK:
-        _logger.LogError("Failed to get latest toggles: Service returned error {statusCode}({responseBody})", response.StatusCode, await response.Content.ReadAsStringAsync());
+        _logger.LogError("Failed to get latest flags: Service returned error {statusCode}({responseBody})", response.StatusCode, await response.Content.ReadAsStringAsync());
         return null;
     }
 

diff --git a/libs/dotnet-sdk/README.md b/libs/dotnet-sdk/README.md
@@ -1,24 +1,30 @@
+# FeatureBoard .Net SDK
+
+FeatureBoard SDK for .Net applications.
+
+
+[![NuGet](https://img.shields.io/nuget/v/FeatureBoard.DotnetSdk.svg)](https://www.nuget.org/packages/FeatureBoard.DotnetSdk/) [![NuGet](https://img.shields.io/nuget/dt/FeatureBoard.DotnetSdk.svg)](https://www.nuget.org/packages/FeatureBoard.DotnetSdk/) ![GitHub Workflow](https://img.shields.io/github/actions/workflow/status/arkahna/featureboard-sdks/main.yml?logo=github)
 
 ## What is FeatureBoard?
 
-FeatureBoard is the future of Feature Toggling and is tailored for SaaS teams on the hunt for a simplified yet highly potent feature toggling solution. FeatureBoard enhances team productivity by allowing everyone to manage software features seamlessly, not just developers.
+FeatureBoard is the future of Feature Management and is tailored for SaaS teams on the hunt for a simplified yet highly potent feature management solution. FeatureBoard enhances team productivity by allowing everyone to manage software features seamlessly, not just developers.
 
-## How do I get started?
+## Getting Started
 
 To get started checkout our [getting started guide](https://docs.featureboard.app).
 
-## Install FeatureBoard .Net SDK
+## Installation
 
 FeatureBoard .Net SDK is installed from NuGet. 
 
 ```powershell
 dotnet add package FeatureBoard.DotnetSdk
 ```
 
-## Setup and example
+## Examples
 
-How to setup and use FeatureBoard .Net SDK can be found in our [documentation](https://docs.featureboard.app/sdks/dotnet-sdk/). 
+Examples of how to use the FeatureBoard .Net SDK can be found in our [documentation](https://docs.featureboard.app/sdks/dotnet-sdk/). 
 
-## Release notes
+## Release Notes
 
-Our changelog [can be found on GitHub](https://github.com/arkahna/featureboard-sdks/blob/main/libs/dotnet-sdk/CHANGELOG.md).
+Our changelog can be found on [Github](https://github.com/arkahna/featureboard-sdks/blob/main/libs/dotnet-sdk/CHANGELOG.md).
diff --git a/libs/js-sdk/README.md b/libs/js-sdk/README.md
@@ -1,9 +1,11 @@
 # FeatureBoard Client JavaScript SDK
-![npm](https://img.shields.io/npm/v/%40featureboard%2Fjs-sdk?logo=npm) ![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/arkahna/featureboard-sdks/main.yml?logo=github)
 
-FeatureBoard SDK for browser based web applications.
+FeatureBoard SDK for browser-based web applications.
 
-Looking for our NodeJS server side SDK, you can find it [here](https://www.npmjs.com/package/@featureboard/node-sdk).
+![npm](https://img.shields.io/npm/v/%40featureboard%2Fjs-sdk?logo=npm) ![npm](https://img.shields.io/npm/dt/%40featureboard%2Fjs-sdk?logo=npm) ![GitHub Workflow](https://img.shields.io/github/actions/workflow/status/arkahna/featureboard-sdks/main.yml?logo=github)
+
+
+Looking for our NodeJS server side SDK? You can find it [here](https://www.npmjs.com/package/@featureboard/node-sdk).
 
 ## Installation
 
@@ -21,6 +23,7 @@ pnpm add @featureboard/js-sdk
 
 How to setup and use FeatureBoard JavaScript SDK can be found in our [documentation](https://docs.featureboard.app/sdks/javascript-sdk/).
 
-## Release notes
 
-You can find our [changelog here](/libs/js-sdk/CHANGELOG.md).
+## Release Notes
+
+Our changelog can be found on [GitHub](https://github.com/arkahna/featureboard-sdks/blob/main/libs/js-sdk/CHANGELOG.md).
diff --git a/libs/js-sdk/package.json b/libs/js-sdk/package.json
@@ -10,7 +10,8 @@
         "url": "git+https://github.com/arkahna/featureboard-sdks.git"
     },
     "keywords": [
-        "Feature toggle",
+        "Feature management",
+        "Feature toggles",
         "Feature flags"
     ],
     "bugs": {

diff --git a/libs/js-sdk/src/utils/fetchFeaturesConfiguration.ts b/libs/js-sdk/src/utils/fetchFeaturesConfiguration.ts
@@ -36,7 +36,7 @@ export async function fetchFeaturesConfigurationViaHttp(
             audiences,
         )
         throw new Error(
-            `Failed to get latest toggles: Service returned error ${response.status} (${response.statusText})`,
+            `Failed to get latest flags: Service returned error ${response.status} (${response.statusText})`,
         )
     }
 

diff --git a/libs/live-connection/README.md b/libs/live-connection/README.md
@@ -1,6 +1,6 @@
 # FeatureBoard - Live Connection
 
-Provides live update functionality in FeatureBoard using WebSockets.
+Live update functionality for FeatureBoard using WebSockets.
 
 On the server it uses the 'ws' module, and in the browser the WebSocket global.
 

diff --git a/libs/node-sdk/README.md b/libs/node-sdk/README.md
@@ -1,8 +1,10 @@
 # FeatureBoard NodeJS SDK
 
-![npm](https://img.shields.io/npm/v/%40featureboard%2Fnode-sdk?logo=npm) ![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/arkahna/featureboard-sdks/main.yml?logo=github)
+FeatureBoard SDK for server side NodJS.
+
+![npm](https://img.shields.io/npm/v/%40featureboard%2Fnode-sdk?logo=npm)  ![npm](https://img.shields.io/npm/dt/%40featureboard%2Fnode-sdk?logo=npm) ![GitHub Workflow](https://img.shields.io/github/actions/workflow/status/arkahna/featureboard-sdks/main.yml?logo=github)
+
 
-FeatureBoard SDK for server side NodeJS.
 
 Looking for our JS SDK for browser based web applications, you can find it [here](https://www.npmjs.com/package/@featureboard/js-sdk).
 
@@ -22,6 +24,6 @@ pnpm add @featureboard/node-sdk
 
 How to setup and use FeatureBoard NodeJS SDK can be found in our [documentation](https://docs.featureboard.app/sdks/nodejs-sdk/).
 
-## Release notes
+## Release Notes
 
-You can find our [changelog here](/libs/node-sdk/CHANGELOG.md).
+Our changelog can be found on [GitHub](https://github.com/arkahna/featureboard-sdks/blob/main/libs/node-sdk/CHANGELOG.md).
diff --git a/libs/node-sdk/src/utils/fetchFeaturesConfiguration.ts b/libs/node-sdk/src/utils/fetchFeaturesConfiguration.ts
@@ -24,7 +24,7 @@ export async function fetchFeaturesConfigurationViaHttp(
 
     if (response.status !== 200 && response.status !== 304) {
         throw new Error(
-            `Failed to get latest toggles: Service returned error ${response.status} (${response.statusText})`,
+            `Failed to get latest flags: Service returned error ${response.status} (${response.statusText})`,
         )
     }
 

diff --git a/libs/nx-plugin/README.md b/libs/nx-plugin/README.md
@@ -1,11 +1,22 @@
 # nx-plugin
 
-This library was generated with [Nx](https://nx.dev).
+NX plugin for FeatureBoard.
 
-## Building
+![npm](https://img.shields.io/npm/v/%40featureboard%2Fnx-plugin?logo=npm) ![npm](https://img.shields.io/npm/dt/%40featureboard%2Fnx-plugin?logo=npm) ![GitHub Workflow](https://img.shields.io/github/actions/workflow/status/arkahna/featureboard-sdks/main.yml?logo=github)
 
-Run `nx build nx-plugin` to build the library.
 
-## Running unit tests
+## Installation
 
-Run `nx test nx-plugin` to execute the unit tests via Vitest
+The FeatureBoard React SDK is available on NPM.
+
+```bash
+npm add @featureboard/nx-plugin
+# Or
+yarn add @featureboard/nx-plugin
+# Or
+pnpm add @featureboard/nx-plugin
+```
+
+## Release Notes
+
+Our changelog can be found on [GitHub](https://github.com/arkahna/featureboard-sdks/blob/main/libs/nx-plugin/CHANGELOG.md).
diff --git a/libs/nx-plugin/package.json b/libs/nx-plugin/package.json
@@ -7,7 +7,8 @@
         "url": "git+https://github.com/arkahna/featureboard-sdks.git"
     },
     "keywords": [
-        "Feature toggle",
+        "Feature management",
+        "Feature toggles",
         "Feature flags"
     ],
     "bugs": {

diff --git a/libs/react-sdk/README.md b/libs/react-sdk/README.md
@@ -1,9 +1,10 @@
 # FeatureBoard React SDK
 
-![npm](https://img.shields.io/npm/v/%40featureboard%2Freact-sdk?logo=npm) ![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/arkahna/featureboard-sdks/main.yml?logo=github)
-
 FeatureBoard SDK for React applications.
 
+![npm](https://img.shields.io/npm/v/%40featureboard%2Freact-sdk?logo=npm) ![npm](https://img.shields.io/npm/dt/%40featureboard%2Freact-sdk?logo=npm) ![GitHub Workflow](https://img.shields.io/github/actions/workflow/status/arkahna/featureboard-sdks/main.yml?logo=github)
+
+
 ## Installation
 
 The FeatureBoard React SDK is available on NPM.
@@ -20,6 +21,6 @@ pnpm add @featureboard/react-sdk
 
 How to setup and use FeatureBoard React SDK can be found in our [documentation](https://docs.featureboard.app/sdks/react-sdk/).
 
-## Release notes
+## Release Notes
 
-You can find our [changelog here](/libs/react-sdk/CHANGELOG.md).
+Our changelog can be found on [GitHub](https://github.com/arkahna/featureboard-sdks/blob/main/libs/react-sdk/CHANGELOG.md).
diff --git a/libs/react-sdk/package.json b/libs/react-sdk/package.json
@@ -10,7 +10,8 @@
         "url": "git+https://github.com/arkahna/featureboard-sdks.git"
     },
     "keywords": [
-        "Feature toggle",
+        "Feature management",
+        "Feature toggles",
         "Feature flags"
     ],
     "bugs": {