From 401e7d3876596f154e2ad5190c881130edb7445e Mon Sep 17 00:00:00 2001 From: David Dooling Date: Wed, 29 Aug 2018 07:39:55 -0500 Subject: [PATCH] Prepare for 1.0.0 release --- CHANGELOG.md | 2 +- README.md | 37 ++++++++++++++++++++++--------------- package-lock.json | 2 +- package.json | 2 +- 4 files changed, 25 insertions(+), 18 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7537abd..3cd9f0c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -# Change Log +# Changelog All notable changes to this project will be documented in this file. diff --git a/README.md b/README.md index 4476322..f253990 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,12 @@ transforms][docs]. ## Using +Add this package to your package's dependencies. + +``` +$ npm install @atomist/yaml-updater +``` + This module defines and exports several functions for formatting and updating YAML. The published module contains the TypeScript type definitions. To use from TypeScript, import the functions you want to @@ -133,29 +139,30 @@ If you find a problem, please create an [issue][]. ## Development -You will need to install [node][] to build and test this project. +You will need to install [Node.js][node] to build and test this +project. [node]: https://nodejs.org/ (Node.js) -### Build and Test +### Build and test + +Install dependencies. -Use the following package scripts to build, test, and perform other -development tasks. +``` +$ npm install +``` + +Use the `build` package script to compile, test, lint, and build the +documentation. -Command | Reason -------- | ------ -`npm install` | install project dependencies -`npm run build` | compile, test, lint, and generate docs -`npm run lint` | run TSLint against the TypeScript -`npm run compile` | generate types from GraphQL and compile TypeScript -`npm test` | run tests -`npm run autotest` | run tests every time a file changes -`npm run clean` | remove files generated during the build +``` +$ npm run build +``` ### Release -Releases are managed by the [Atomist SDM][atomist-sdm]. Press the -release button in the Atomist dashboard or Slack. +Releases are handled via the [Atomist SDM][atomist-sdm]. Just press +the 'Approve' button in the Atomist dashboard or Slack. [atomist-sdm]: https://github.com/atomist/atomist-sdm (Atomist Software Delivery Machine) diff --git a/package-lock.json b/package-lock.json index 86751f9..af91eff 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "@atomist/yaml-updater", - "version": "0.4.2", + "version": "1.0.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 78ab922..4358fe5 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@atomist/yaml-updater", - "version": "0.4.2", + "version": "1.0.0", "description": "Update YAML documents while ensuring clean diffs", "author": { "name": "Atomist",