diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..675710b --- /dev/null +++ b/.editorconfig @@ -0,0 +1,21 @@ +# EditorConfig is awesome: https://EditorConfig.org +root = true + +[*] +charset = utf-8 +indent_size = 2 +indent_style = tab +insert_final_newline = true +trim_trailing_whitespace = true + +[*.{ls,yml,yaml}] +indent_style = space + +[*.{cjs,js,mjs,ts}] +block_comment_start = /* +block_comment = * +block_comment_end = */ + +[*.{markdown,md}] +indent_style = space +trim_trailing_whitespace = false diff --git a/.github/workflows/default.yml b/.github/workflows/node.yml similarity index 66% rename from .github/workflows/default.yml rename to .github/workflows/node.yml index 618ad79..14928ba 100644 --- a/.github/workflows/default.yml +++ b/.github/workflows/node.yml @@ -1,6 +1,27 @@ -name: CI +name: 'Run tests on NodeJS' -on: [push] +on: + push: + paths: + - '.github/workflows/node.yml' + - '1.0/*' + - '2.0/*' + - '2.5/*' + - '3.0/*' + - '4.0/*' + - 'package.json' + - 'pnpm-lock.yaml' + pull_request: + paths: + - '.github/workflows/node.yml' + - '1.0/*' + - '2.0/*' + - '2.5/*' + - '3.0/*' + - '4.0/*' + - 'package.json' + - 'pnpm-lock.yaml' + workflow_dispatch: jobs: default: diff --git a/package.json b/package.json index 177bee6..b19762e 100644 --- a/package.json +++ b/package.json @@ -1,47 +1,47 @@ { - "name": "cc-md", - "version": "0.4.1", - "description": "Markdown-formatted Creative Commons licenses", - "author": "idleberg", - "license": "CC0-1.0", - "files": [ - "1.0/", - "2.0/", - "2.5/", - "3.0/", - "4.0/", - "legacy/", - "LICENSE", - "readme.markdown" - ], - "scripts": { - "lint": "npm run test", - "prepare": "husky", - "test": "remark -u lint ./**/*.markdown ./readme.markdown" - }, - "keywords": [ - "markdown", - "creative", - "commons", - "licenses", - "cc" - ], - "repository": { - "type": "git", - "url": "git+https://github.com/idleberg/Creative-Commons-Markdown.git" - }, - "bugs": { - "url": "https://github.com/idleberg/Creative-Commons-Markdown/issues" - }, - "homepage": "https://github.com/idleberg/Creative-Commons-Markdown#readme", - "devDependencies": { - "husky": "^9.1.6", - "lint-staged": "^15.2.10", - "remark-cli": "^12.0.1", - "remark-lint": "^10.0.0" - }, - "lint-staged": { - "*.{md|markdown}": "remark -u lint" - }, - "packageManager": "pnpm@9.9.0+sha512.60c18acd138bff695d339be6ad13f7e936eea6745660d4cc4a776d5247c540d0edee1a563695c183a66eb917ef88f2b4feb1fc25f32a7adcadc7aaf3438e99c1" + "name": "cc-md", + "version": "0.4.1", + "description": "Markdown-formatted Creative Commons licenses", + "author": "idleberg", + "license": "CC0-1.0", + "files": [ + "1.0/", + "2.0/", + "2.5/", + "3.0/", + "4.0/", + "legacy/", + "LICENSE", + "readme.markdown" + ], + "scripts": { + "lint": "npm run test", + "prepare": "husky", + "test": "remark -u lint ./**/*.markdown ./readme.markdown" + }, + "keywords": [ + "markdown", + "creative", + "commons", + "licenses", + "cc" + ], + "repository": { + "type": "git", + "url": "git+https://github.com/idleberg/Creative-Commons-Markdown.git" + }, + "bugs": { + "url": "https://github.com/idleberg/Creative-Commons-Markdown/issues" + }, + "homepage": "https://github.com/idleberg/Creative-Commons-Markdown#readme", + "devDependencies": { + "husky": "^9.1.6", + "lint-staged": "^15.2.10", + "remark-cli": "^12.0.1", + "remark-lint": "^10.0.0" + }, + "lint-staged": { + "*.{md|markdown}": "remark -u lint" + }, + "packageManager": "pnpm@9.9.0+sha512.60c18acd138bff695d339be6ad13f7e936eea6745660d4cc4a776d5247c540d0edee1a563695c183a66eb917ef88f2b4feb1fc25f32a7adcadc7aaf3438e99c1" } diff --git a/readme.markdown b/readme.markdown index da9c0de..ae5555c 100644 --- a/readme.markdown +++ b/readme.markdown @@ -1,9 +1,8 @@ # Creative Commons Markdown -[![npm](https://flat.badgen.net/npm/license/cc-md)](https://www.npmjs.org/package/cc-md) -[![npm](https://flat.badgen.net/npm/v/cc-md)](https://www.npmjs.org/package/cc-md) -[![CI](https://img.shields.io/github/actions/workflow/status/idleberg/Creative-Commons-Markdown/default.yml?style=flat-square)](https://github.com/idleberg/Creative-Commons-Markdown/actions) - +[![License](https://img.shields.io/github/license/idleberg/Creative-Commons-Markdown?color=blue&style=for-the-badge)](https://github.com/idleberg/Creative-Commons-Markdown/blob/main/LICENSE) +[![Version: npm](https://img.shields.io/npm/v/cc-md?style=for-the-badge)](https://www.npmjs.org/package/cc-md) +[![CI: Node](https://img.shields.io/github/actions/workflow/status/idleberg/Creative-Commons-Markdown/node.yml?logo=nodedotjs&logoColor=white&style=for-the-badge)](https://github.com/idleberg/Creative-Commons-Markdown/actions) On November 25th, 2013, [Creative Commons](http://creativecommons.org/) announced their next generation licenses: [Creative Commons 4.0](https://creativecommons.org/weblog/entry/40768). By default, these are available as [HTML](http://creativecommons.org/licenses/) or [plaintext](http://creativecommons.org/weblog/entry/41127). This project adds [Markdown](http://daringfireball.net/projects/markdown/)-formatted licenses to that list, while aiming for best [compatibility on GitHub](https://github.github.com/gfm/).