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:15:01 +02:00
parent 04076176a8
commit 8d84e852fc
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -1,8 +1,9 @@
RFC: TinyLogs format # RFC: TinyLogs format
Status: Draft Status: Draft
Last update: 2021-06-08
1. Introduction ## Introduction
A Tinylog is a simple file with all "microblog" style entries to share small contents and interact with other other geminauts' tinylog. A Tinylog is a simple file with all "microblog" style entries to share small contents and interact with other other geminauts' tinylog.
@ -13,12 +14,12 @@ The goal of this RFC is to standardize the tinylog format for better coherence b
This will also allow better tools around tinylogs to improve both authors and readers experience reading micro entries. This will also allow better tools around tinylogs to improve both authors and readers experience reading micro entries.
2. Tinylog format ## Tinylog format
This tinylog format proposal is composed of a mandatory part that tinylogs must be compatible with and optional information that author could add as meta information about their tinylog. This tinylog format proposal is composed of a mandatory part that tinylogs must be compatible with and optional information that author could add as meta information about their tinylog.
2.1 Mandatory format ### Mandatory format
Each tinylog entry must be formated as follow: Each tinylog entry must be formated as follow:
``` ```
@ -56,7 +57,7 @@ Mon 02 Jan 2006 03:04[:05] PM MST
Each entry must be separated with 2 new lines (ie paragraph break). Each entry must be separated with 2 new lines (ie paragraph break).
2.2 Optional information ### Optional information
Additional informations could be added at the top of your tinylog file: Additional informations could be added at the top of your tinylog file:
``` ```