Skip to content

Commit

Permalink
Update docs, bump version (#91)
Browse files Browse the repository at this point in the history
* Update README

* Add ignored revs file

* Update CHANGELOG and bump version
  • Loading branch information
jgarber623 authored Dec 12, 2023
1 parent b89a756 commit 2997a3b
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 14 deletions.
11 changes: 11 additions & 0 deletions .git-blame-ignore-revs
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Since git version 2.23, git-blame has a feature to ignore certain commits.
#
# This file contains a list of commits that are not likely what you are looking
# for in `git blame`. You can set this file as a default ignore file for blame
# by running the following command:
#
# $ git config blame.ignoreRevsFile .git-blame-ignore-revs

f52463193421e977884da27d8b07778b0992c653
ec123ec58af9e276e121a71a3655ac01a6a762c4
9a405bfd98122f9c7480ada8e74f4b6bf790ef83
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Changelog

## 3.0.0 / 2023-12-12

- **Breaking change:** Update Thor and Webmention dependencies (#90) (b89a756)
- Address RuboCop warnings (#89) (9a405bf)
- Code cleanup (#88) (445984f)
- **Breaking change:** Update Ruby versions (#87) (8a36cd3)
- Development: 2.7.8
- Minimum supported: 2.7

## 2.0.0 / 2022-05-20

- **Breaking change:** Rewrite gem code (35e9442)
Expand Down
16 changes: 3 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,13 @@
[![Gem](https://img.shields.io/gem/v/webmention-cli.svg?logo=rubygems&style=for-the-badge)](https://rubygems.org/gems/webmention-cli)
[![Downloads](https://img.shields.io/gem/dt/webmention-cli.svg?logo=rubygems&style=for-the-badge)](https://rubygems.org/gems/webmention-cli)
[![Build](https://img.shields.io/github/actions/workflow/status/jgarber623/webmention-cli/ci.yml?branch=main&logo=github&style=for-the-badge)](https://github.com/jgarber623/webmention-cli/actions/workflows/ci.yml)
[![Maintainability](https://img.shields.io/codeclimate/maintainability/jgarber623/webmention-cli.svg?logo=code-climate&style=for-the-badge)](https://codeclimate.com/github/jgarber623/webmention-cli)
[![Coverage](https://img.shields.io/codeclimate/c/jgarber623/webmention-cli.svg?logo=code-climate&style=for-the-badge)](https://codeclimate.com/github/jgarber623/webmention-cli/code)

## Getting Started

Before installing and using webmention-cli, you'll want to have [Ruby](https://www.ruby-lang.org) 2.6 (or newer) installed. It's recommended that you use a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm).

webmention-cli is developed using Ruby 2.6.10 and is additionally tested against Ruby 2.7, 3.0, and 3.1 using [GitHub Actions](https://github.com/jgarber623/webmention-cli/actions).

## Installation

Before installing and using webmention-cli, you'll want to have [Ruby](https://www.ruby-lang.org) 2.7 (or newer) installed.

```sh
gem install webmention-cli
$ gem install webmention-cli
```

## Usage
Expand Down Expand Up @@ -75,10 +69,6 @@ $ webmention verify https://kartikprabhu.com/notes/re-launching-franciscms https

The command will return a zero exit code if `<source>` links to `<target>` _and_ the provided vouch URL links to the `<source>`'s domain. A non-zero exist code is returned in all other cases.

## Contributing

Interested in helping improve webmention-cli? Awesome! Your help is greatly appreciated. See [CONTRIBUTING.md](https://github.com/jgarber623/webmention-cli/blob/main/CONTRIBUTING.md) for details.

## Acknowledgments

webmention-cli wouldn't exist without Webmention and the hard work put in by everyone involved in the [IndieWeb](https://indieweb.org) movement.
Expand Down
2 changes: 1 addition & 1 deletion lib/webmention/cli/version.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

module Webmention
module CLI
VERSION = "2.0.0"
VERSION = "3.0.0"
end
end

0 comments on commit 2997a3b

Please sign in to comment.