mirror of
https://github.com/samsonjs/mit-license.git
synced 2026-06-29 05:39:31 +00:00
Add information about license property in user file
This commit is contained in:
parent
1d65967dfc
commit
a2519cd8aa
1 changed files with 17 additions and 0 deletions
17
README.md
17
README.md
|
|
@ -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.
|
||||
|
|
|
|||
Loading…
Reference in a new issue