diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index ec657d1..24c2403 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -10,22 +10,12 @@ jobs: packages: write steps: - uses: actions/checkout@v2 - # Setup .npmrc file to publish to GitHub Packages - uses: actions/setup-node@v3 with: node-version: '16.x' - registry-url: 'https://npm.pkg.github.com' # Defaults to the user or organization that owns the workflow file scope: '@metricq' - run: yarn install - - run: yarn workspaces foreach npm publish --tolerate-republish --access public - env: - NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - uses: actions/setup-node@v3 - with: - node-version: '16.x' - # Defaults to the user or organization that owns the workflow file - scope: '@metricq' - run: yarn workspaces foreach npm publish --tolerate-republish --access public env: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} diff --git a/README.md b/README.md index 5824301..072c1e8 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,10 @@ # metricq-js -## Install via npm/yarn - -Add the following line to your `.npmrc` in the project root: +For the readme of the single package, visit the corresponding folders or click here for [live](packages/live/README.md) and [history](packages/history/README.md) -``` -@metricq:registry=https://npm.pkg.github.com -``` +## Install via npm/yarn -After that install via +Install via ```bash npm install @metricq/live @@ -22,6 +18,9 @@ or yarn add @metricq/history ``` +**If you have previously installed the packages from the GitHub package registry, please delete the registry +configuration for the metricq scope.** + ## Usage ```js diff --git a/packages/history/README.md b/packages/history/README.md new file mode 100644 index 0000000..78365ed --- /dev/null +++ b/packages/history/README.md @@ -0,0 +1,22 @@ +# @metricq/history + +MetricQ is a highly-scalable, distributed metric data processing framework based on RabbitMQ. This package provides a client library for the [metricq-grafana](https://github.com/metricq/metricq-grafana) endpoint. + +## Install via npm/yarn + +Install via + +```bash +npm install @metricq/history +or +yarn add @metricq/history +``` + +**If you have previously installed the packages from the GitHub package registry, please delete the registry +configuration for the metricq scope.** + +## Usage + +```js +import MetricQHistory from "@metricq/history" +``` diff --git a/packages/history/package.json b/packages/history/package.json index 82c9ad4..fbe07fe 100644 --- a/packages/history/package.json +++ b/packages/history/package.json @@ -19,8 +19,5 @@ }, "browser": { "child_process": false - }, - "publishConfig": { - "registry": "https://npm.pkg.github.com" } } diff --git a/packages/live/README.md b/packages/live/README.md new file mode 100644 index 0000000..6856621 --- /dev/null +++ b/packages/live/README.md @@ -0,0 +1,22 @@ +# @metricq/live + +MetricQ is a highly-scalable, distributed metric data processing framework based on RabbitMQ. This package provides a client library for the [metricq-sink-websocket](https://github.com/metricq/metricq-sink-websocket) endpoint. + +## Install via npm/yarn + +Install via + +```bash +npm install @metricq/live +or +yarn add @metricq/live +``` + +**If you have previously installed the packages from the GitHub package registry, please delete the registry +configuration for the metricq scope.** + +## Usage + +```js +import MetricQLive from "@metricq/live" +``` diff --git a/packages/live/package.json b/packages/live/package.json index 3da17a8..5b289dd 100644 --- a/packages/live/package.json +++ b/packages/live/package.json @@ -1,6 +1,6 @@ { "name": "@metricq/live", - "version": "3.0.0", + "version": "3.0.1", "description": "MetricQ is a highly-scalable, distributed metric data processing framework based on RabbitMQ. This package provides a client library for the metricq-sink-websocket endpoint.", "repository": { "type": "git", @@ -19,8 +19,5 @@ }, "browser": { "child_process": false - }, - "publishConfig": { - "registry": "https://npm.pkg.github.com" } }