Skip to content

Commit

Permalink
chore(docs): add license and badges to README (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
greatislander authored Jun 25, 2024
1 parent 933c7bd commit 7a8c962
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 1 deletion.
13 changes: 13 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# BSD 3-Clause License

Copyright (c) 2024, OCAD University

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# IDRC CMS Authenticator

[![BSD 3-Clause license](https://badgen.net/github/license/inclusive-design/idrc-cms-authenticator)](https://github.com/inclusive-design/idrc-cms-authenticator/blob/main/LICENSE.md)
[![Latest release](https://badgen.net/github/release/inclusive-design/idrc-cms-authenticator)](https://github.com/inclusive-design/idrc-cms-authenticator/releases/latest)
[![codecov](https://codecov.io/gh/inclusive-design/idrc-cms-authenticator/graph/badge.svg?token=7DVX7LF4BH)](https://codecov.io/gh/inclusive-design/idrc-cms-authenticator)

A simple [Express](https://expressjs.com/) application which allows [Sveltia CMS](https://github.com/sveltia/sveltia-cms) or [Decap CMS](https://decapcms.org) to authenticate with [GitHub](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps) or [GitLab](https://docs.gitlab.com/ee/api/oauth2.html#authorization-code-flow).

Based on [netlify-cms-github-oauth-provider](https://github.com/vencax/netlify-cms-github-oauth-provider) and [sveltia-cms-auth](https://github.com/sveltia/sveltia-cms-auth).
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
},
"keywords": ["decap-cms", "sveltia-cms", "github", "gitlab", "auth"],
"author": "OCAD University <[email protected]>",
"license": "MIT",
"license": "BSD-3-Clause",
"dependencies": {
"cookie-parser": "^1.4.6",
"dotenv": "^16.4.5",
Expand Down

0 comments on commit 7a8c962

Please sign in to comment.