diff --git a/CHANGELOG.md b/CHANGELOG.md index 58db342..5bc98de 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,12 @@ # Changelog -All changes to this project are documented in this file. +All notable changes to this project will be documented in this file. -This project adheres to [Semantic Versioning](https://semver.org), except that – as is typical in the Rust community – the minimum supported Rust version may be increased without a major version increase. +This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html), except that – as is typical in the Rust community – the minimum supported Rust version may be increased without a major version increase. -Do not manually edit this file. It will be automatically updated when a new release is published. +The format of this changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). +## [0.1.0](https://github.com/scouten/asciidoc-parser/releases/tag/v0.1.0) +_26 October 2024_ + +* Initial public release of this crate. (Still very much a work-in-progress.) diff --git a/README.md b/README.md index af4bdc9..7cfd7c6 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # AsciiDoc parser for Rust -[![CI](https://github.com/scouten/asciidoc-parser/actions/workflows/ci.yml/badge.svg)](https://github.com/scouten/asciidoc-parser/actions/workflows/ci.yml) [![Codecov](https://codecov.io/gh/scouten/asciidoc-parser/graph/badge.svg?token=ULDZN1IUR9)](https://codecov.io/gh/scouten/asciidoc-parser) [![CodSpeed](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/scouten/asciidoc-parser) +[![CI](https://github.com/scouten/asciidoc-parser/actions/workflows/ci.yml/badge.svg)](https://github.com/scouten/asciidoc-parser/actions/workflows/ci.yml) [![Latest Version](https://img.shields.io/crates/v/asciidoc-parser.svg)](https://crates.io/crates/asciidoc-parser) [![docs.rs](https://img.shields.io/docsrs/asciidoc-parser)](https://docs.rs/asciidoc-parser/) [![Codecov](https://codecov.io/gh/scouten/asciidoc-parser/graph/badge.svg?token=ULDZN1IUR9)](https://codecov.io/gh/scouten/asciidoc-parser) [![CodSpeed](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/scouten/asciidoc-parser) This is an effort to write a semantic parser for the [AsciiDoc language](https://docs.asciidoctor.org/asciidoc/latest/). -The project is in its infancy as of December 2023 and in **no way ready to use.** +The project is in its infancy as of October 2024 and in **no way ready to use.** You're welcome to follow along and contribute with the understanding that I may or may not drive this project a mature (1.0) release. @@ -18,4 +18,4 @@ The `asciidoc-parser` crate is distributed under the terms of both the MIT licen See [LICENSE-APACHE](./LICENSE-APACHE) and [LICENSE-MIT](./LICENSE-MIT). -Note that some components and dependent crates are licensed under different terms; please check the license terms for each crate and component for details. +Note that some components and dependent crates may be licensed under different terms; please check the license terms for each crate and component for details.