Skip to content

Commit

Permalink
Add CHANGELOG, update README, prepare for next release.
Browse files Browse the repository at this point in the history
  • Loading branch information
baron1405 committed Apr 14, 2024
1 parent eb1ac66 commit 3c8590d
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 4 deletions.
17 changes: 17 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Changelog

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.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [unreleased]

## [1.0.0] - 2024-04-14

### Added

- First release

[unreleased]: https://github.com/cthing/xmlwriter/compare/1.0.0...HEAD
[1.0.0]: https://github.com/cthing/xmlwriter/releases/tag/1.0.0
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# ![C Thing Software](https://www.cthing.com/branding/CThingSoftware-57x60.png "C Thing Software") escapers

[![CI](https://github.com/cthing/escapers/actions/workflows/ci.yml/badge.svg)](https://github.com/cthing/escapers/actions/workflows/ci.yml)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.cthing/escapers/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.cthing/escapers)
[![javadoc](https://javadoc.io/badge2/org.cthing/xmlwriter/javadoc.svg)](https://javadoc.io/doc/org.cthing/escapers)

A Java library that escapes strings for CSV, HTML, Java, JavaScript, JSON, XML and YAML.

## Usage
Expand Down Expand Up @@ -38,8 +42,8 @@ Escaping for each supported language follows the pattern:
HtmlEscaper.Option.USE_DECIMAL);
```

The Javadoc for each escaper provides detailed information about the character replacements performed and the
options supported.
The [Javadoc](https://javadoc.io/doc/org.cthing/escapers) for each escaper provides detailed information about
the character replacements performed and the options supported.

## Building
The library is compiled for Java 17. If a Java 17 toolchain is not available, one will be downloaded.
Expand Down
4 changes: 2 additions & 2 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ plugins {
alias(libs.plugins.versions)
}

val baseVersion = "1.0.0"
val isSnapshot = false
val baseVersion = "1.0.1"
val isSnapshot = true

val isCIServer = System.getenv("CTHING_CI") != null
val buildNumber = if (isCIServer) System.currentTimeMillis().toString() else "0"
Expand Down

0 comments on commit 3c8590d

Please sign in to comment.