From a2519cd8aae5235977518b0842677ac896365a24 Mon Sep 17 00:00:00 2001 From: Richie Bendall Date: Sun, 2 Jun 2019 20:38:19 +1200 Subject: [PATCH] Add information about license property in user file --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 791ef451..2a58c634 100644 --- a/README.md +++ b/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.