Skip to content

Commit

Permalink
Release v0.2.6
Browse files Browse the repository at this point in the history
* Deprecate the 'update' command
* Mention the manpage in the README
* Use stable URLs in the README
  • Loading branch information
bfontaine committed May 11, 2019
1 parent db4d50b commit 85517be
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 6 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# rfc Changelog

## v0.2.6 (2019/05/11)

* Add a manpage
* Deprecate the `update` command, that self-updates the script. It’s still
there, but it doesn’t appear in the documentation.

## v0.2.5 (2018/06/27)

* Use `grep -R` instead of shell globbing in `rfc search` not to break on
Expand Down
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Use `rfc help` to see all available subcommands.

```sh
mkdir -p ~/bin
curl -sL https://raw.githubusercontent.com/bfontaine/rfc/master/rfc > ~/bin/rfc
curl -sL https://raw.githubusercontent.com/bfontaine/rfc/v0.2.6/rfc > ~/bin/rfc
chmod u+x ~/bin/rfc
```

Expand All @@ -56,6 +56,10 @@ If it’s not in your `PATH`, you have to add it:
echo 'export PATH="$HOME/bin:$PATH"' >> ~/.bashrc
```

You may also want to install the `manpage`, located in [`man/rfc.1`][manpage].

[manpage]: https://raw.githubusercontent.com/bfontaine/rfc/v0.2.6/man/rfc.1

### Using Homebrew

If you use [Homebrew](http://brew.sh) or [Linuxbrew](http://linuxbrew.sh/) you
Expand All @@ -79,8 +83,8 @@ The default directory is `~/.RFCs`.

## Troubleshooting

`rfc` version 0.2.5 added a special `--debug` flag that, if passed as the first
argument, enables tracing of all the Bash commands in the script.
`rfc` version 0.2.5 and above has a special `--debug` flag that, if passed as
the first argument, enables tracing of all the Bash commands in the script.

## Credits

Expand Down
5 changes: 2 additions & 3 deletions rfc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#
# Author: Baptiste Fontaine
# License: MIT
# Version: 0.2.5 (2018/06/27)
# Version: 0.2.6 (2019/05/11)
#
# URL: https://github.com/bfontaine/rfc
#
Expand Down Expand Up @@ -161,7 +161,7 @@ __rfc() {
rm -rf "$rfc_dir/_tmp"
}

# rfc update
# rfc update (deprecated)
update() {
fetch_url $RFC_REMOTE_URL $0
chmod +x "$0"
Expand All @@ -175,7 +175,6 @@ __rfc() {
rfc --help # display this text and exit
rfc <number> # display the RFC <number>
rfc update # Update the script
rfc search [OPTS] X # Search for X in local RFCs using grep with OPTS
passed through
rfc list # List locally available RFCs
Expand Down

0 comments on commit 85517be

Please sign in to comment.