From 2a0fe6550796c5ddf141a4300809556ec25063c5 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sun, 26 Nov 2023 10:37:23 -0800 Subject: minor tweaks to REAMDE --- README.adoc | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/README.adoc b/README.adoc index e62fd7be..d34e5d43 100644 --- a/README.adoc +++ b/README.adoc @@ -5,12 +5,7 @@ endif::[] = nng - nanomsg-next-gen // Note: This README is optimized for display with Asciidoctor, or -// on the github status page. An HTML version is in the same directory -// and may be more pleasantly formatted for human readers (when opened -// in a browser). - -// Note: If you're updating this file, don't forget to re-run asciidoctor -// to update the aforementioned HTML file! +// on the GitHub project page at https://github.com/nanomsg/nng. image:https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg[Stand With Ukraine,link="https://stand-with-ukraine.pp.ua"] image:https://img.shields.io/github/actions/workflow/status/nanomsg/nng/linux.yml?branch=master&logoColor=grey&logo=ubuntu&label=[Linux Status,link="https://github.com/nanomsg/nng/actions"] @@ -151,7 +146,9 @@ With a Linux or UNIX environment: The API documentation is provided in Asciidoc format in the `docs/man` subdirectory, and also https://nanomsg.github.io/nng[online]. -The <> page is a good starting point. +The <> page provides a conceptual overview and links to +manuals for various patterns. +The <> page is a good starting point for the API reference. You can also purchase a copy of the http://staysail.tech/books/nng_reference/index.html[__NNG Reference Manual__]. @@ -165,7 +162,7 @@ These are located in the `demo` directory. == Legacy Compatibility -A legacy libnanomsg compatible API is available, and while it offers +A legacy `libnanomsg` compatible API is available, and while it offers less capability than the modern NNG API, it may serve as a transition aid. Please see <> for details. -- cgit v1.2.3-70-g09d2