From f17017475bec9679086d97273970a6871fd6a107 Mon Sep 17 00:00:00 2001 From: Camilla Teodoro Date: Mon, 28 Aug 2023 18:24:48 -0300 Subject: [PATCH] chore: add Releasing note to README --- .travis.yml | 2 +- README.md | 21 +++++++++++++++++++-- 2 files changed, 20 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index b3be97a..c3ac8c8 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,3 +1,3 @@ language: node_js node_js: - - '8' + - "14" diff --git a/README.md b/README.md index 58d18b5..547f6ab 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ formatters for good eggs [![Build Status](http://img.shields.io/travis/goodeggs/goodeggs-formatters.svg?style=flat-square)](https://travis-ci.org/goodeggs/goodeggs-formatters) - ## Usage ``` @@ -15,7 +14,6 @@ npm install goodeggs-formatters goodeggsFormatters = require 'goodeggs-formatters' ``` - ## Contributing ``` @@ -25,3 +23,22 @@ $ npm test ``` _Module scaffold generated by [generator-goodeggs-npm](https://github.com/goodeggs/generator-goodeggs-npm)._ + +## Releasing + +To release a new version of this module, use yarn to bump the version + +in `package.json` and create a git tag, then push. This will automatically + +get published to the NPM registry via CI. + +```sh + + +yarn version --new-version= + +git push --follow-tags + + + +```