From 1759faaaf2c4401d0083c12be5fbd558660efc1f Mon Sep 17 00:00:00 2001 From: Simon Chapman Date: Sat, 2 Apr 2022 20:36:55 +0100 Subject: [PATCH] correct readme --- .github/workflows/main.yml | 13 ++++++------- README.md | 13 ++++++++++--- deploy.txt | 12 ++++++------ package.json | 2 +- 4 files changed, 23 insertions(+), 17 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 3b0e014..7519214 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -3,9 +3,8 @@ name: NPM Publish # This action will trigger on every release get created on: - push: - branches: - - live + release: + types: [created] # Job will run on a ubuntu instance jobs: @@ -13,11 +12,11 @@ jobs: runs-on: ubuntu-latest steps: # Checkout the code - - uses: actions/checkout@v2 - # Setup node with version 12.x and NPM registry url - - uses: actions/setup-node@v1 + - uses: actions/checkout@v3 + # Setup node with version 16.x and NPM registry url + - uses: actions/setup-node@v3 with: - node-version: "12.x" + node-version: "16.x" registry-url: "https://registry.npmjs.org" # Run yarn install to install project packages - run: yarn install diff --git a/README.md b/README.md index 4aeb563..b05fa2e 100644 --- a/README.md +++ b/README.md @@ -11,15 +11,22 @@ # RCPCH Growth Chart React Component Library -For all guidance on this component, implementation and contributing to the RCPCH growth chart projects, please see our [documentation](https://../../digital-growth-charts-documentation/docs/products/react-component.md) +For all guidance on this component, implementation and contributing to the RCPCH growth chart projects, please see our [documentation](https://growth.rcpch.ac.uk/products/react-component/) ## Version 6.0 Supported Features -* Corrected/Chronological age with toggle with theme styling -* Zoom with zoom reset (optional prop) * Event logging - events associated with measurements * Bone ages * Midparental heights with midparental centile lines (at +2 and -2 SDS) * Copy/Paste button (optional prop) * SDS Lines for BMI centile chart * SDS charts + +## Existing features + +* Centile charts for UK-WHO, Turner's and Down's syndromes (data for lines bundled) +* Corrected/Chronological age with toggle with theme styling +* Zoom with zoom reset (optional prop) +* Styling props for chart look and feel +* Meets all UK growth chart national standards +* Designed and built by RCPCH diff --git a/deploy.txt b/deploy.txt index d05ceea..4898d00 100644 --- a/deploy.txt +++ b/deploy.txt @@ -1,11 +1,11 @@ -This are the rules on deploy +Note: there is a github action to publish to NPM on creation or a release -This is a pre-release and therefore published as a release candidate to npm. -To deploy: +If this is a prerelease: 1. version major.minor.patch-rc1 2. npm publish --tag alpha -Before merging to live need to: +If this is a release +1. version major.minor.patch +2. npm publish --access public -2. reverse these changes -3. (delete this file) \ No newline at end of file +note npm version patch | npm version minor | npm version major from the command line can bump the version \ No newline at end of file diff --git a/package.json b/package.json index 2a777bd..33f7785 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@rcpch/digital-growth-charts-react-component-library", - "version": "6.0.0", + "version": "6.0.1", "main": "build/index.js", "module": "build/index.esm.js", "files": [