diff --git a/LICENSE b/LICENSE deleted file mode 100644 index e69de29..0000000 diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..fdbf4a0 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,9 @@ +MIT License + +Copyright (c) 2021 Rocketseat + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index cf18741..05fddd9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# commitlint-config-rocketseat +# @rocketseat/commitlint-config Shareable [`commitlint`](https://github.com/conventional-changelog/commitlint) config used by Rocketseat. @@ -8,14 +8,14 @@ Installing: ```sh # npm -npm i -D commitlint-config-rocketseat +npm i -D @rocketseat/commitlint-config # yarn -yarn add -D commitlint-config-rocketseat +yarn add -D @rocketseat/commitlint-config ``` Apply the config to `commitlint`: ```sh -echo "module.exports = {extends: ['rocketseat']};" > commitlint.config.js +echo "module.exports = {extends: ['@rocketseat/commitlint-config']};" > commitlint.config.js ``` diff --git a/package.json b/package.json index b3a4496..8426994 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "commitlint-config-rocketseat", + "name": "@rocketseat/commitlint-config", "version": "0.0.1", "description": "Shareable commitlint config used by Rocketseat", "main": "index.js", @@ -9,12 +9,20 @@ }, "repository": { "type": "git", - "url": "https://github.com/Rocketseat/commitlint-config-rocketseat.git" + "url": "https://github.com/Rocketseat/commitlint-config.git" }, + "bugs": { + "url": "https://github.com/Rocketseat/commitlint-config/issues" + }, + "homepage": "https://github.com/Rocketseat/commitlint-config#readme", "keywords": [ "commitlint", "config", + "commitlint-config", "rocketseat", "git" - ] + ], + "engines": { + "node": ">=v10" + } }