Add information about license property in user file

This commit is contained in:
Richie Bendall 2019-06-02 20:38:19 +12:00
parent 1d65967dfc
commit a2519cd8aa
No known key found for this signature in database
GPG key ID: 1C6A99DFA9D306FC

View file

@ -53,6 +53,7 @@ Available fields:
- format
- gravatar
- theme
- license
### copyright
@ -144,6 +145,22 @@ And if you want to show your gravatar, just add the `gravatar` boolean property:
Note that the gravatar requires the email property. You also need to check the compatibility of the chosen theme. Currently, only the default theme supports Gravatar.
### license
By default the license display is set to the MIT License. The licenses you can specify as default are as follows:
- MIT
- ISC
To set the default license, set the `license` property:
```json
{
"copyright": "Remy Sharp, http://remysharp.com",
"license": "ISC"
}
```
### Themes
If you've got an eye for design (or like me: not): you can contribute a theme by adding a CSS file to the `themes` directory. You can use the latest CSS technologies since they are automatically polyfilled. The default theme is simple and clean, but you can add your own as you like.