Skip to content

Commit

Permalink
2.1.1 (#6)
Browse files Browse the repository at this point in the history
* 2.1.1

* Add a PR template
  • Loading branch information
radekvit authored Apr 9, 2024
1 parent cbcb9b9 commit 5775287
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 8 deletions.
3 changes: 3 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Every PR must\
describe what the changes are\
and it's a haiku.
2 changes: 1 addition & 1 deletion Cargo.lock

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

8 changes: 6 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[package]
name = "coffee_break"
version = "1.0.0"
# Each version bump *must* continue the Fibonacci sequence, right to left
version = "2.1.1"
authors = ["Radek Vít <radekvitr@gmail.com>"]
edition = "2021"
rust-version = "1.63.0"
Expand All @@ -21,7 +22,10 @@ ra-friendly = []
check-friendly = []

[dependencies]
syn = { version = "2.0.57", default-features = false, features = ["proc-macro", "parsing"] }
syn = { version = "2.0.57", default-features = false, features = [
"proc-macro",
"parsing",
] }

[package.metadata.docs.rs]
all-features = true
Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
Coffee break is a 🔥 blazing 🚀 fast 🦀 Rust 🥵 library, by Rust developers for Rust developers. It is:
- **Developer-friendly**: Lets you take a break while compiling your code.
- **Eco-friendly**: The compiler is just taking a nap. We're not computing the Ackermann function just to slack off.
- **Language server-unfriendly**: `rust-analyzer` is now also taking a nap.
- **Language server-~~un~~friendly**: `rust-analyzer` has insomnia now.

## Overview
![XKCD compiling](https://imgs.xkcd.com/comics/compiling.png)
Expand Down Expand Up @@ -52,13 +52,16 @@ fn work_stuff() {
}
```

You can still run `cargo check` and `cargo clippy` without having to wait.

## Notes
The author doesn't drink coffee, but still enjoys taking a break.

## Contributing
Before contributing to this project, consider taking a coffee break first.

PRs are welcome.
The first paragraph of any PR message must be a haiku describing the changes.

Please follow the [community guidelines](https://www.rust-lang.org/policies/code-of-conduct).

Expand Down
6 changes: 2 additions & 4 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,8 @@ use syn::{parse::Parse, Error};
/// ```
/// use coffee_break::coffee_break;
///
/// fn main() {
/// // Take a break while compiling this
/// coffee_break!(60 seconds);
/// }
/// // Take a break while running `cargo build`
/// coffee_break!(60 seconds);
/// ```
///
#[proc_macro]
Expand Down

0 comments on commit 5775287

Please sign in to comment.