README.adoc in asciidoctor-epub3-1.5.0.alpha.9 vs README.adoc in asciidoctor-epub3-1.5.0.alpha.10
- old
+ new
@@ -1,8 +1,8 @@
= {project-name}: A _native_ EPUB3 converter for AsciiDoc
Dan Allen <https://github.com/mojavelinux[@mojavelinux]>; Sarah White <https://github.com/graphitefriction[@graphitefriction]>
-v1.5.0.alpha.9, 2019-04-04
+v1.5.0.alpha.10, 2020-01-20
// Settings:
:experimental:
:idprefix:
:idseparator: -
:imagesdir: data/samples/images
@@ -28,10 +28,11 @@
// URIs:
:uri-project: https://github.com/asciidoctor/{project-handle}
:uri-gem: http://rubygems.org/gems/asciidoctor-epub3
:uri-repo: {uri-project}
:uri-issues: {uri-repo}/issues
+:uri-ci: {uri-repo}/actions?query=workflow%3ACI
:uri-discuss: http://discuss.asciidoctor.org
:uri-rvm: https://rvm.io
:uri-asciidoctor: http://asciidoctor.org
:uri-idpf: http://www.idpf.org/
:uri-epub: http://www.idpf.org/epub/31/spec/epub-spec.html
@@ -48,10 +49,11 @@
:uri-android-sdk: http://developer.android.com/sdk/index.html
ifdef::status[]
image:https://img.shields.io/gem/v/asciidoctor-epub3.svg[Latest Release,link={uri-gem}]
image:https://img.shields.io/badge/license-MIT-blue.svg[MIT License,link=#copyright]
+image:{uri-repo}/workflows/CI/badge.svg[GitHub Actions,link={uri-ci}]
endif::[]
{project-name} is a set of Asciidoctor extensions for converting AsciiDoc documents directly to the EPUB3 and KF8/MOBI e-book formats.
== Introduction
@@ -247,11 +249,11 @@
NOTE: Eventually, we envision introducing a dedicated block macro to represent a spine item so that we don't overload the meaning of the include directive.
However, for the time being, the include directive fills this role.
== Prerequisites
-All that's needed to use {project-name} is Ruby (1.9.3 or above; 2.2.x recommended) and a few Ruby gems, which we'll explain how to install in the next section.
+All that's needed to use {project-name} is Ruby 2.3 or newer and a few Ruby gems, which we'll explain how to install in the next section.
To check if you have Ruby available, use the `ruby` command to query the installed version:
$ ruby --version
@@ -465,14 +467,14 @@
$ asciidoctor-epub3 -D output -a ebook-validate data/samples/sample-book.adoc
.Validation success
[.output]
....
-Epubcheck Version 3.0.1
-
-Validating against EPUB version 3.0
+Validating using EPUB version 3.0.1 rules.
No errors or warnings detected.
+Messages: 0 fatal / 0 errors / 0 warnings / 0 info
+EPUBCheck completed
....
If the EPUB3 archive contains any errors, they will be output in your terminal.
.EPUB Standard & Validator
@@ -544,10 +546,10 @@
*-a ebook-format=<format>* ::
Specifies the ebook format to generate (epub3 or kf8, default: epub3)
*-a ebook-validate* ::
- Runs Epubcheck 3.0.1 to validate output file against the EPUB3 specification
+ Runs {uri-epubcheck}[EpubCheck] to validate output file against the EPUB3 specification
*-a ebook-compress=<0|1|2|none|standard|huffdic>* ::
Controls the compression type used by kindlegen (0=none [default if unset], 1=standard [default if empty], 2=huffdic)
*-v, --version* ::