readme: Explain what this plugin does

5 years ago · 0a0dea42ce
parent f8c9295816
commit 0a0dea42ce
1 changed files with 5 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -1,6 +1,10 @@
 # Nodeinfo plugin for GNU social

-TODO
+Plugin that presents basic instance information using the [NodeInfo standard](http://nodeinfo.diaspora.software/).
+
+At the moment, the information is presented at the "/main/nodeinfo/2.0" endpoint.
+
+Other tools can then scrape that information and present it in various ways. For example: [https://fediverse.network/](https://fediverse.network/)

 # Instructions