Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates metadata #3

Merged
merged 3 commits into from
Feb 2, 2025
Merged

Updates metadata #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4ed94fc
Updates metadata
jkaye2012 Feb 2, 2025
d82738d
Updates changelog
jkaye2012 Feb 2, 2025
8a33107
Updates broken README links
jkaye2012 Feb 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/verify.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
name: "Verify"
on:
pull_request:
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
cancel-in-progress: true
jobs:
verify:
runs-on: ubuntu-latest
Expand Down
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.0.2] - 2025-02-02

There are no functional changes in this release. The version was bumped to update crates.io
metadata and documentation for a proper release.

## [0.0.1] - 2025-02-02

### Added
Expand Down
2 changes: 2 additions & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ name = "refined"
version = "0.0.1"
edition = "2021"
description = "Simple refinement types; parse, don't validate!"
documentation = "https://docs.rs/refined"
repository = "https://github.com/jkaye2012/refined"
license = "MIT OR Apache-2.0"

[dependencies]
Expand Down
8 changes: 4 additions & 4 deletions readme.md → README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Refined

![Crates.io Version](https://img.shields.io/crates/v/refined)
![Release Status](https://img.shields.io/github/actions/workflow/status/jkaye2012/refined/publish.yml?branch=main)
![Release Status](https://img.shields.io/github/actions/workflow/status/jkaye2012/refined/publish.yml)
![Crates.io License](https://img.shields.io/crates/l/refined)

Simple [refinement types](https://en.wikipedia.org/wiki/Refinement_type) for Rust.

For detailed information, please see the [documentation on docs.rs](https://docs.rs/crate/refined/latest).
For detailed information, please see the [documentation on docs.rs](https://docs.rs/refined/latest/refined).

## Quickstart

The [basic usage example on docs.rs](file:///home/jkaye/git/refined/target/doc/refined/index.html#basic-usage)
The [basic usage example on docs.rs](https://docs.rs/refined/latest/refined/#basic-usage)
is a minimal example that should be easy to follow.

You can also use the [examples](https://github.com/jkaye2012/refined/examples) to get started. Each example is
You can also use the [examples](https://github.com/jkaye2012/refined/tree/main/examples) to get started. Each example is
a complete cargo project of its own. They are meant to be run with `cargo run` so that you can view their output
and reference it against the code.