README.adoc in metanorma-mpfa-0.5.6 vs README.adoc in metanorma-mpfa-0.5.7
- old
+ new
@@ -1,23 +1,19 @@
= Metanorma-MPFA: Metanorma processor for MPFA documents
image:https://img.shields.io/gem/v/metanorma-mpfa.svg["Gem Version", link="https://rubygems.org/gems/metanorma-mpfa"]
-image:https://github.com/metanorma/metanorma-mpfa/workflows/macos/badge.svg["Build Status (macOS)", link="https://github.com/metanorma/metanorma-mpfa/actions?workflow=macos"]
-image:https://github.com/metanorma/metanorma-mpfa/workflows/ubuntu/badge.svg["Build Status (ubuntu)", link="https://github.com/metanorma/metanorma-mpfa/actions?workflow=ubuntu"]
-image:https://github.com/metanorma/metanorma-mpfa/workflows/windows/badge.svg["Build Status (Windows)", link="https://github.com/metanorma/metanorma-mpfa/actions?workflow=windows"]
+image:https://github.com/metanorma/metanorma-mpfa/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-mpfa/actions?workflow=rake"]
image:https://codeclimate.com/github/metanorma/metanorma-mpfa/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-mpfa"]
image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-mpfa.svg["Pull Requests", link="https://github.com/metanorma/metanorma-mpfa/pulls"]
image:https://img.shields.io/github/commits-since/metanorma/metanorma-mpfa/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-mpfa/releases"]
-_Formerly known as_ `metanorma-mpfd`.
-
WARNING: This gem is still under development. Moreover, unlike other Metanorma gems,
there is no formal MPFA specification, and this work is still currently exploratory.
== Functionality
-This gem processes http://asciidoctor.org/[Asciidoctor] documents following
+This gem processes https://www.metanorma.com/[Metanorma documents] following
a template for generating documents for the http://www.mpfa.org.hk[Mandatory Provident Fund Schemes Authority of Hong Kong].
The gem currently inherits from the https://github.com/metanorma/metanorma-standoc
gem, and aligns closely to it. Refer to https://metanorma.com[] for guidance.
@@ -75,5 +71,9 @@
* Example documents are avalable at the https://github.com/metanorma/mn-samples-mpfa[MPFA Samples] repository.
////
* Document templates are available at the https://github.com/metanorma/mn-templates-mpf[mn-templates-mpf] repository.
/////
+
+== Notes
+
+Metanorma-MPFA was formerly published as `metanorma-mpfd`.