From cd4dcaaf34e315e64d279c3eb3eeb497696f0d86 Mon Sep 17 00:00:00 2001 From: Richie Bendall Date: Fri, 31 May 2019 23:44:35 +1200 Subject: [PATCH] Add extra copyright, links in the copyright owner and year range --- .travis.yml | 5 +- README.md | 52 +++++------- licenses/0BSD.ejs | 2 +- licenses/AFL-3-0.ejs | 2 +- licenses/AGPL-3-0.ejs | 4 +- licenses/ISC.ejs | 2 +- licenses/MIT.ejs | 2 +- licenses/NCSA.ejs | 2 +- licenses/OFL.ejs | 2 +- licenses/UPL.ejs | 2 +- licenses/components/footer.ejs | 2 +- licenses/components/header.ejs | 7 +- package.json | 11 ++- robots.txt | 2 + server.ts | 146 ++++++++++++++++++++++++--------- users/example.json | 5 ++ users/localhost.json | 9 +- users/null.json | 5 ++ yarn.lock | Bin 144253 -> 145005 bytes 19 files changed, 169 insertions(+), 93 deletions(-) create mode 100644 robots.txt create mode 100644 users/example.json create mode 100644 users/null.json diff --git a/.travis.yml b/.travis.yml index aee51157..3a172df0 100644 --- a/.travis.yml +++ b/.travis.yml @@ -10,4 +10,7 @@ before_install: npm i -g yarn install: yarn install -script: yarn test +script: + - yarn test + - yarn lint + - yarn build diff --git a/README.md b/README.md index 5c461a15..a28415f4 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,6 @@ Available fields: - email - format - gravatar -- version - theme ### copyright @@ -59,13 +58,29 @@ You can also use an array to hold multiple copyright holders: ```json { - "copyright": ["Remy Sharp (http://remysharp.com)", "Richie Bendall (https://richienb.github.io)"] + "copyright": ["Remy Sharp", "Richie Bendall"] } ``` Which will be formatted as: - Remy Sharp (http://remysharp.com) and Richie Bendall (https://richienb.github.io) + Remy Sharp and Richie Bendall + +If you additionally want to include a URL and email with each copyright holder, use objects in the array: + +```json +{ + "copyright": [{ + "name": "Remy Sharp, https://remysharp.com", + "url": "https://remysharp.com", + "email": "remy@remysharp.com" + }, { + "name": "Richie Bendall, https://www.richie-bendall.ml", + "url": "https://www.richie-bendall.ml", + "email": "richiebendall@gmail.com" + }] +} +``` ### url @@ -117,28 +132,6 @@ 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 version targeting - -License version targeting allows you to link your MIT license to a specific revision in this project - therefore fixing it permanently to a specific license text. - -Though I don't expect the license text to change ever, this is just some extra assurance for you. - -Targeting requires the [sha from the license commit](https://github.com/remy/mit-license/commits/master/LICENSE.html). This can be specified on the URL (in your permalink) or in the JSON file. - -For example: (make sure to view-source) shows an older version of the LICENSE.html file (compared to the [latest version](http://rem.mit-license.org) - the older version didn't have the new themes). - -This can also be targeted in my JSON file: - -```json -{ - "copyright": "Remy Sharp, http://remysharp.com", - "url": "http://remysharp.com", - "version": "a526rbf7" -} -``` - -Note that if no version is supplied, the latest copy of the LICENSE.html will be displayed with your information included. - ### 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. @@ -198,13 +191,6 @@ The following types of requests can be made to this project: the json file (currently none specified on `rem`) - HTML - Text -- a526bf7ad1 version, HTML, or the - default format specified in the json file (again, none specified for - `rem` so defaults to HTML) -- a526bf7ad1 version, - HTML -- a526bf7ad1 version, - text The url also supports including a start year: @@ -212,7 +198,7 @@ The url also supports including a start year: show a license year range of 2009-2016 (2016 being the current year) - [http://rem.mit-license.org/2009-2010](http://rem.mit-license.org/2009-2010/) allows me to force the year range -- a526bf7ad1 version, with year range of 2009-2010 in plain text +- year range of 2009-2010 in plain text Finally, the url also supports pinning the year diff --git a/licenses/0BSD.ejs b/licenses/0BSD.ejs index 290691ac..21e00d8f 100644 --- a/licenses/0BSD.ejs +++ b/licenses/0BSD.ejs @@ -7,7 +7,7 @@
<%- gravatar %>

BSD Zero Clause License (0BSD)

-

Copyright © <%= info %>

+

Copyright © <%- info %>

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted.

diff --git a/licenses/AFL-3-0.ejs b/licenses/AFL-3-0.ejs index d45d9b93..918ee59e 100644 --- a/licenses/AFL-3-0.ejs +++ b/licenses/AFL-3-0.ejs @@ -7,7 +7,7 @@
<%- gravatar %>

Academic Free License v3.0 (AFL-3.0)

-

Copyright © <%= info %>

+

Copyright © <%- info %>

This Academic Free License (the "License") applies to any original work of authorship (the "Original Work") whose owner (the "Licensor") has placed the diff --git a/licenses/AGPL-3-0.ejs b/licenses/AGPL-3-0.ejs index faeda924..e1c449f5 100644 --- a/licenses/AGPL-3-0.ejs +++ b/licenses/AGPL-3-0.ejs @@ -7,7 +7,7 @@

<%- gravatar %>

GNU Affero General Public License (AGPL-3.0)

-

Copyright © <%= info %>

+

Copyright © <%- info %>

Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

Preamble

@@ -634,7 +634,7 @@ the "copyright" line and a pointer to where the full notice is found.

<one line to give the program's name and a brief idea of what it does.> - Copyright © <%= info %>

+ Copyright © <%- info %>

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published diff --git a/licenses/ISC.ejs b/licenses/ISC.ejs index 4b1b8695..0e6f7b8b 100644 --- a/licenses/ISC.ejs +++ b/licenses/ISC.ejs @@ -7,7 +7,7 @@

<%- gravatar %>

The ISC License (ISC)

-

Copyright © <%= info %>

+

Copyright © <%- info %>

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above diff --git a/licenses/MIT.ejs b/licenses/MIT.ejs index f29c83a1..bcda400c 100644 --- a/licenses/MIT.ejs +++ b/licenses/MIT.ejs @@ -7,7 +7,7 @@

<%- gravatar %>

The MIT License (MIT)

-

Copyright © <%= info %>

+

Copyright © <%- info %>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal diff --git a/licenses/NCSA.ejs b/licenses/NCSA.ejs index 76d97885..03d68af5 100644 --- a/licenses/NCSA.ejs +++ b/licenses/NCSA.ejs @@ -7,7 +7,7 @@

<%- gravatar %>

NCSA Open Source License (NCSA)

-

Copyright © <%= info %>

+

Copyright © <%- info %>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files diff --git a/licenses/OFL.ejs b/licenses/OFL.ejs index e355c318..37905617 100644 --- a/licenses/OFL.ejs +++ b/licenses/OFL.ejs @@ -7,7 +7,7 @@

<%- gravatar %>

The SIL Open Font License (OFL)

-

Copyright © <%= info %>

+

Copyright © <%- info %>

This Font Software is licensed under the SIL Open Font License, Version 1.1. This license is copied below, and is also available with a FAQ at: diff --git a/licenses/UPL.ejs b/licenses/UPL.ejs index 01948e90..025ff880 100644 --- a/licenses/UPL.ejs +++ b/licenses/UPL.ejs @@ -7,7 +7,7 @@

<%- gravatar %>

The Universal Permissive License (UPL)

-

Copyright © <%= info %>

+

Copyright © <%- info %>

Subject to the condition set forth below, permission is hereby granted to any person obtaining a copy of this software, associated documentation and/or data diff --git a/licenses/components/footer.ejs b/licenses/components/footer.ejs index 414ecfd1..2107f147 100644 --- a/licenses/components/footer.ejs +++ b/licenses/components/footer.ejs @@ -1,3 +1,3 @@

diff --git a/licenses/components/header.ejs b/licenses/components/header.ejs index 0b4f192d..290e278b 100644 --- a/licenses/components/header.ejs +++ b/licenses/components/header.ejs @@ -1,7 +1,10 @@ MIT License - - + + + +