Skip to content

pfrazee/dat.json

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 

Repository files navigation

dat.json

The WIP specification for the dat.json meta format.

{
  "title": "My paper library",
  "author": "Julian Gruber <julian@juliangruber.com>"
}

Specification

Add a dat.json with any of those keys - all are optional - to the root of a dat archive to help tooling work with your archive more nicely:

.title

A short but descriptive human friendly title.

.author

The archive's author - the packager, not necessarily the data's author as well. Can be either an object with any of those keys:

{
  "name": "Julian Gruber",
  "email": "julian@juliangruber.com",
  "web": "https://juliangruber.com"
}

or a string with at least the name and any of the segments email and web:

"NAME <EMAIL> (WEB)"

like for example:

  • "Julian Gruber"
  • "Julian Gruber <julian@juliangruber.com>"
  • "Julian Gruber (https://juliangruber.com/)"
  • "Julian Gruber <julian@juliangruber.com> (https://juliangruber.com/)"

Support

  • Dat-Desktop will use .title to display a nice archive name instead of just its key

About

The WIP specification for the dat.json meta format

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors