show-a-license/package.json

A site to provide an easy way to show licenses and their human-readable explanations.

{
  "name": "show-a-license",
  "version": "2.0.4",
  "description": "A site to provide an easy way to show licenses and their human-readable explanations.",
  "main": "lib/index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "start": "statique -p 9000",
    "watch": "watchify lib/index.js -o js/index.js -v"
  },
  "author": "Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)",
  "contributors": [
    "Silviu Bogan <silviubogan@gmail.com> (https://lumea-lui-silviu.blogspot.ro)"
  ],
  "license": "MIT",
  "blah": {
    "ex_img": "http://i.imgur.com/AB42LJo.png",
    "description": [
      {
        "h2": "Your help is needed! :heart:"
      },
      {
        "p": "Contribute by explaining licenses. Check out [this issue](https://github.com/IonicaBizau/show-a-license/issues/1). :memo: :book:"
      },
      {
        "h2": "Usage"
      },
      {
        "p": "Whether you just want to show a license or see its human-readable explanation, you can use this website. It provides a nice querystring API documented below:"
      },
      {
        "ul": [
          "`#license-<license>` (hash): set the license to display",
          "`fullname=<name>`: set the copyright holder name",
          "`year=<name>`: set the starting copyright yea",
          "`hide_explanations=<true|false>` (default: `false`): hide the explanations column"
        ]
      },
      {
        "h2": "Developer installation"
      },
      {
        "ul": [
          "`cd build; node update-licenses-list.js; cd ..`",
          "In the end, run in parallel `npm run watch` and `npm start`",
          "Open in your browser [http://localhost:9000/index.html](http://localhost:9000/index.html)."
        ]
      }
    ],
    "example": [
      {
        "h2": "Examples"
      },
      {
        "ul": [
          "To see the MIT license access this url: https://ionicabizau.github.io/show-a-license#license-mit",
          "To set the copyright holder name, use the `fullname=<name>` querystring parameter: https://ionicabizau.github.io/show-a-license?fullname=Alice#license-mit",
          "To set the starting copyright year use the `year` parameter: https://ionicabizau.github.io/show-a-license?year=2013&fullname=Alice#license-mit",
          "To hide the explanations column, you have to use `hide_explanations=true`: https://ionicabizau.github.io/show-a-license?hide_explanations=true&year=2013&fullname=Alice#license-mit"
        ]
      }
    ],
    "contributing": [
      {
        "h3": "Explaining a license"
      },
      {
        "p": "Explanations are kept in `txt` files in the [`explanations`](/explanations) directory, having the license names (e.g. `mit.txt`)."
      },
      {
        "p": "Contributions in this directions are really appreciated."
      },
      {
        "ol": [
          "Fork this repository.",
          "Edit the `explanations/<license>.txt` file (you can follow [`explanations/mit.txt`](/explanations/mit.txt) as example).",
          "Add yourself as contributor in [`package.json`](/package.json).",
          "Raise a pull request! :tada:"
        ]
      },
      {
        "h3": "Adding a new license"
      },
      {
        "p": "If the license you're searching for is missing, make sure you add it."
      },
      {
        "ol": [
          "Fork this repository.",
          "Add a new file in the [`licenses`](/licenses) directory, named `<license>.txt` (replace `<license>` with the license name) and then do the same in the [`explanations`](/explanations) directory (you can follow the MIT license example: see [`explanations/mit.txt`](/explanations/mit.txt) and [`licenses/mit.txt`](/licenses/mit.txt)).",
          "Give nice, funny and useful explanation in the `explanations/<license>.txt` file you added.",
          "Add yourself as contributor in [`package.json`](/package.json).",
          "Raise a pull request! :tada:"
        ]
      }
    ],
    "thanks": {
      "ul": [
        "[github/choosealicense.com](https://github.com/github/choosealicense.com)–a good inspiration source (some ideas and CSS were taken from here) :sparkle:",
        "[**@Cerberus-tm**](https://github.com/Cerberus-tm)–who had the idea for the site name :cake:"
      ]
    }
  },
  "dependencies": {
    "barbe": "^3.0.16",
    "elm-select": "^1.3.0",
    "err": "^2.1.12",
    "same-time": "^2.2.0",
    "whatwg-fetch": "^3.6.2",
    "year-range": "^1.1.0"
  },
  "devDependencies": {
    "abs": "^1.1.0",
    "statique": "^3.1.0",
    "w-json": "^1.2.0",
    "watchify": "^4.0.0"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/IonicaBizau/show-a-license.git"
  },
  "keywords": [
    "license",
    "show",
    "understand",
    "list",
    "explain"
  ],
  "bugs": {
    "url": "https://github.com/IonicaBizau/show-a-license/issues"
  },
  "homepage": "https://github.com/IonicaBizau/show-a-license#readme",
  "files": [
    "bin/",
    "app/",
    "lib/",
    "dist/",
    "src/",
    "scripts/",
    "resources/",
    "menu/",
    "cli.js",
    "index.js",
    "index.d.ts",
    "package-lock.json",
    "bloggify.js",
    "bloggify.json",
    "bloggify/"
  ]
}