fix(READMEs): Add various READMEs, remove Discovery SDK

rdkcentral · Apr 17, 2023 · 80365af · 80365af
1 parent 0f2d647
commit 80365af
Show file tree

Hide file tree

Showing 18 changed files with 60 additions and 178 deletions.
diff --git a/src/sdks/core/CHANGELOG.md b/src/sdks/core/CHANGELOG.md
@@ -0,0 +1 @@
+../../../CHANGELOG.md
diff --git a/src/sdks/core/CONTRIBUTING.md b/src/sdks/core/CONTRIBUTING.md
@@ -0,0 +1 @@
+../../../CONTRIBUTING.md
diff --git a/src/sdks/core/LICENSE b/src/sdks/core/LICENSE
@@ -0,0 +1 @@
+../../../LICENSE
diff --git a/src/sdks/core/NOTICE b/src/sdks/core/NOTICE
@@ -0,0 +1 @@
+../../../NOTICE
diff --git a/src/sdks/core/README.md b/src/sdks/core/README.md
@@ -0,0 +1,26 @@
+---
+title: Firebolt SDKs
+---
+
+[![semantic-release: conventional](https://img.shields.io/badge/semantic--release-conventional-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
+
+# Firebolt JS SDK
+For building Firebolt compliant apps.
+
+## Usage
+To install, run:
+
+```
+npm install @firebolt-js/sdk
+```
+
+To use the package, import one of it's modules, e.g.:
+
+```js
+import { Lifecycle } from '@firebolt-js/sdk'
+```
+
+## Contributing
+The Firebolt Core SDK is built using the Firebolt OpenRPC toolset:
+
+See [Firebolt OpenRPC](https://www.github.com/rdkcentral/firebolt-openrpc/), for more info. 
diff --git a/src/sdks/discovery/.npmignore b/src/sdks/discovery/.npmignore
diff --git a/src/sdks/discovery/jest.config.json b/src/sdks/discovery/jest.config.json
diff --git a/src/sdks/discovery/package.json b/src/sdks/discovery/package.json
diff --git a/src/sdks/discovery/sdk.config.json b/src/sdks/discovery/sdk.config.json
diff --git a/src/sdks/discovery/sdk/index.mjs b/src/sdks/discovery/sdk/index.mjs
diff --git a/src/sdks/discovery/src/js/sdk/index.mjs b/src/sdks/discovery/src/js/sdk/index.mjs
diff --git a/src/sdks/discovery/test/suite/basic.test.ts b/src/sdks/discovery/test/suite/basic.test.ts
diff --git a/src/sdks/discovery/tsconfig.json b/src/sdks/discovery/tsconfig.json
diff --git a/src/sdks/manage/CHANGELOG.md b/src/sdks/manage/CHANGELOG.md
@@ -0,0 +1 @@
+../../../CHANGELOG.md
diff --git a/src/sdks/manage/CONTRIBUTING.md b/src/sdks/manage/CONTRIBUTING.md
@@ -0,0 +1 @@
+../../../CONTRIBUTING.md
diff --git a/src/sdks/manage/LICENSE b/src/sdks/manage/LICENSE
@@ -0,0 +1 @@
+../../../LICENSE
diff --git a/src/sdks/manage/NOTICE b/src/sdks/manage/NOTICE
@@ -0,0 +1 @@
+../../../NOTICE
diff --git a/src/sdks/manage/README.md b/src/sdks/manage/README.md
@@ -0,0 +1,26 @@
+---
+title: Firebolt SDKs
+---
+
+[![semantic-release: conventional](https://img.shields.io/badge/semantic--release-conventional-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
+
+# Firebolt JS SDK
+For building Firebolt compliant apps.
+
+## Usage
+To install, run:
+
+```
+npm install @firebolt-js/sdk
+```
+
+To use the package, import one of it's modules, e.g.:
+
+```js
+import { Lifecycle } from '@firebolt-js/sdk'
+```
+
+## Contributing
+The Firebolt Core SDK is built using the Firebolt OpenRPC toolset:
+
+See [Firebolt OpenRPC](https://www.github.com/rdkcentral/firebolt-openrpc/), for more info.