hyperreal/gemini-tinylog-rfc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
bacardi55 2021-06-08 00:19:03 +02:00
parent 8d84e852fc
commit 79efe3d82a
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -8,6 +8,7 @@ Last update: 2021-06-08
A Tinylog is a simple file with all "microblog" style entries to share small contents and interact with other other geminauts' tinylog.
The original idea and most "rules" comes from Drew/uoou/Friendo:
=> gemini://friendo.monster/log/lace.gmi
The goal of this RFC is to standardize the tinylog format for better coherence between authors by providing a consistent approach.
@ -27,11 +28,11 @@ Each tinylog entry must be formated as follow:
<Content>
```
It starts with a second level header containing a <date> then a space and then the title of the entry.
It starts with a second level header (`##`), followed by a space and then <date> followed by a space and then the title of the entry.
<Entry Title> format: Any text without line new line.
`<Entry Title>` format: Any text without new line.
<Date> format: 2 possible format for the date:
`<Date>` format: 2 possible format for the date:
YYYY-MM-DD h:m[:s] TZ
@ -52,7 +53,7 @@ example:
Mon 02 Jan 2006 03:04[:05] PM MST
```
<Content> format: Any text without 2 new lines.
`<Content>` format: Any text without 2 new lines.
Each entry must be separated with 2 new lines (ie paragraph break).
@ -66,15 +67,15 @@ author: <author>
avatar: <avatar>
```
<Tinylog Title> Can be any text without a line break.
`<Tinylog Title>` Can be any text without a line break.
<author> format: "@authorName@capsule.tld" with authorName the tinylog author name and "capsule.tld" the url of the author capsule. This intends to simplify communication between authors as well as discovery of new tinylog feeds.
`<author>` format: "@authorName@capsule.tld" with authorName the tinylog author name and "capsule.tld" the url of the author capsule. This intends to simplify communication between authors as well as discovery of new tinylog feeds.
Example:
```
author: @bacardi55@gmi.bacardi55.io
```
<avatar>: 1 emoji or 1 letter. Can be followed by a space and an optional text (eg: to indicate the code for the emoji)
`<avatar>`: 1 emoji or 1 letter. Can be followed by a space and an optional text (eg: to indicate the code for the emoji)
example:
```
avatar: 🐘