Skip to content

Commit

Permalink
correct readme
Browse files Browse the repository at this point in the history
  • Loading branch information
eatyourpeas committed Apr 2, 2022
1 parent 7e43267 commit 1759faa
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 17 deletions.
13 changes: 6 additions & 7 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,20 @@ 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:
build:
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
Expand Down
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
12 changes: 6 additions & 6 deletions deploy.txt
Original file line number Diff line number Diff line change
@@ -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)
note npm version patch | npm version minor | npm version major from the command line can bump the version
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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": [
Expand Down

0 comments on commit 1759faa

Please sign in to comment.