Skip to content

Commit

Permalink
spec: improve abstract
Browse files Browse the repository at this point in the history
  • Loading branch information
dunglas committed Feb 22, 2022
1 parent 658fb96 commit 27c8e24
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
1 change: 0 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,6 @@ To contribute to the protocol itself:
* Make your changes
* [Download Mmark](https://github.com/mmarkdown/mmark/releases)
* [Download `xml2rfc` using pip](https://pypi.org/project/xml2rfc/): `pip install xml2rfc`
* Format the Markdown file: `mmark -markdown -w spec/mercure.md`
* Generate the XML file: `mmark spec/mercure.md > spec/mercure.xml`
* Validate the generated XML file and generate the text file: `xml2rfc --text --v3 spec/mercure.xml`
* Remove non-ASCII characters from the generated `mercure.txt` file (example: K****vin)
Expand Down
3 changes: 2 additions & 1 deletion spec/mercure.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ organization = "Les-Tilleuls.coop"

.# Abstract

Mercure is a protocol enabling the pushing of data updates to web browsers and other HTTP clients in
Mercure provides a common publish-subscribe mechanism for public and private web resources.
Mercure enables the pushing of any web content to web browsers and other HTTP clients in
a fast, reliable and battery-efficient way. It is especially useful for publishing real-time updates
of resources served through web APIs to web and mobile apps.

Expand Down

0 comments on commit 27c8e24

Please sign in to comment.