Skip to content

Commit

Permalink
Prepare for 1.0.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
David Dooling committed Aug 29, 2018
1 parent b4c40ca commit 401e7d3
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 18 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Change Log
# Changelog

All notable changes to this project will be documented in this file.

Expand Down
37 changes: 22 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit 401e7d3

Please sign in to comment.