Skip to content

Commit d5ad267

Browse files
authored
enh: improve docs
1 parent f2d848e commit d5ad267

File tree

6 files changed

+30
-8
lines changed

6 files changed

+30
-8
lines changed

.github/workflows/release.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,16 @@ jobs:
6767
with:
6868
files: target/${{ matrix.target }}/release/poodle-${{ matrix.target }}.zip
6969
generate_release_notes: true
70+
draft: true
71+
crates:
72+
name: Upload to crates.io
73+
runs-on: ubuntu-latest
74+
steps:
75+
- uses: actions/checkout@v2
76+
- uses: actions-rs/toolchain@v1
77+
with:
78+
toolchain: stable
79+
override: true
7080
- uses: katyo/publish-crates@v1
7181
with:
7282
registry-token: ${{ secrets.CARGO_REGISTRY_TOKEN }}

CHANGELOG.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ and Poodle adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
66

77
## [Unreleased]
88

9+
## [0.6.1] - 2022-04-17
10+
### Added
11+
- Docs enhancement.
12+
- Separate publish workflow.
13+
914
## [0.6.0] - 2022-04-17
1015
### Added
1116
- Code refactoring.
@@ -38,7 +43,8 @@ and Poodle adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
3843
- Project structure.
3944
- Enable GitHub Actions.
4045

41-
[Unreleased]: https://github.com/poyea/poodle/compare/v0.6.0...HEAD
46+
[Unreleased]: https://github.com/poyea/poodle/compare/v0.6.1...HEAD
47+
[0.6.1]: https://github.com/poyea/poodle/compare/v0.6.0...v0.6.1
4248
[0.6.0]: https://github.com/poyea/poodle/compare/v0.5.0...v0.6.0
4349
[0.5.0]: https://github.com/poyea/poodle/compare/v0.4.0...v0.5.0
4450
[0.4.0]: https://github.com/poyea/poodle/compare/v0.3.0...v0.4.0

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
We are under development! Feel free to make our Contribution Guidelines better!
44

5+
#### Setting up Poodle
6+
```sh
7+
$ cargo -V
8+
cargo 1.56.0 (4ed5d137b 2021-10-04)
9+
$ cargo install poodle # install from crates.io! (Recommended)
10+
$ cargo install --path . # or install locally
11+
$ cargo run -- start # or run directly
12+
```
13+
514
## Building Poodle for development
615
```sh
716
$ cargo build --all --release # build

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "poodle"
3-
version = "0.6.0"
3+
version = "0.6.1"
44
edition = "2021"
55
authors = ["John Law <[email protected]>"]
66
description = "Not a poodle, but a word-guessing game from your terminal"

README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,9 @@ Not a 🐩 (Poodle), but a word-guessing game from your terminal. 🟩⬛🟩
1010

1111
## How to use it
1212

13-
#### Setting up Poodle
13+
#### Install Poodle 🐩
1414
```sh
15-
$ cargo -V
16-
cargo 1.56.0 (4ed5d137b 2021-10-04)
17-
$ cargo install --path . # install
18-
$ cargo run -- start # or run directly
15+
$ cargo install poodle # install from crates.io!
1916
```
2017

2118
#### Guess today's riddle

0 commit comments

Comments
 (0)