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

Re-add avatar/licence metadata

Browse Source
This commit is contained in:
bacardi55 2021-06-10 23:19:44 +02:00
parent b7ac683b8b
commit ee5abb5d71
1 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,7 +1,7 @@
# RFC: TinyLogs format
Status: Draft
Last update: 2021-06-08
Last update: 2021-06-10
## Introduction
@ -101,21 +101,30 @@ Additional informations could be added at the top of your tinylog file:
<description>
author: <author>
avatar: <emoji>
licence: <licence>
```
`<Tinylog Title>` Can be any text without a line break.
`<description>`: Can be any text without 2 line breaks (= paragraph break). Description can be before or after the metadata but not between.
`<author>` format: `[emoji ]@authorName[@capsule.tld]` with authorName the tinylog author name and "capsule.tld" the url of the author capsule. The emoji and capsule url are optional. 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. The emoji and capsule url are optional. This intends to simplify communication between authors as well as discovery of new tinylog feeds.
Example:
```
author: @bacardi55
author: @bacardi55@gmi.bacardi55.io
author: 🤔 @bacardi55
author: 🤔 @bacardi55@gmi.bacardi55.io
```
`<emoji>` format: emoji [emoji description]. The description is optional.
Example:
```
avatar: 🦪
avatar: 🦪 (:oyster:, U+1F9AA)
```
`<licence>` format: the name of the licence.
Other additional metadata could be added but shouldn't be expected.