docs: update readme

ipfs-shipyard · May 11, 2023 · cabfdfc · cabfdfc
1 parent 0e4b7e1
commit cabfdfc
Show file tree

Hide file tree

Showing 6 changed files with 157 additions and 82 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,5 @@ docs/.DS_Store
 docs/.DS_Store
 docs/.DS_Store
 .DS_Store
+package-lock.json
+*.log
diff --git a/LICENSE b/LICENSE
@@ -1,21 +1,4 @@
-MIT License
+This project is dual licensed under MIT and Apache-2.0.
 
-Copyright (c) 2018 Protocol Labs
-
-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.
+MIT: https://www.opensource.org/licenses/mit
+Apache-2.0: https://www.apache.org/licenses/license-2.0
diff --git a/LICENSE-APACHE b/LICENSE-APACHE
@@ -0,0 +1,5 @@
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
diff --git a/LICENSE-MIT b/LICENSE-MIT
@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+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.
diff --git a/README.md b/README.md
@@ -1,28 +1,40 @@
-# helia-css
+# @helia/css <!-- omit in toc -->
 
 > 🍴 Forked from https://github.com/ipfs-shipyard/ipfs-css
 
 The single-purpose CSS class names and @font-face config to Helia up your UI.
 
 Pairs well with [tachyons].
 
+## Table of contents <!-- omit in toc -->
+
+- [Install](#install)
+- [Usage](#usage)
+  - [CSS in JS](#css-in-js)
+  - [Less](#less)
+  - [SCSS](#scss)
+- [Icons](#icons)
+- [Colors](#colors)
+- [License](#license)
+- [Contribute](#contribute)
+
 ## Install
 
-Add `helia-css` to your project via npm:
+Add `@helia/css` to your project via npm:
 
 ```sh
-npm install helia-css
+npm install @helia/css
 ```
 
 ## Usage
 
-Once you've installed helia-css from npm, the CSS and SCSS files and the web-fonts are available from your `node_modules/helia-css` directory.
+Once you've installed `@helia/css` from npm, the CSS and SCSS files and the web-fonts are available from your `node_modules/@helia/css` directory.
 
 If you are set up with a build process that lets you import css files directly from `node_modules`, then you can just add the following to your CSS file.
 
 ```css
 @import 'tachyons'; /* Optional, jolly good tho */
-@import 'helia-css';
+@import '@helia/css';
 ```
 
 The file includes font-face definitions and single purpose CSS class names that you can compose freely, to create your lovely UI.
@@ -73,59 +85,24 @@ See: https://dweb.link/ipfs/bafybeiebays3i7aem7tptga3kilzux7f5gz6czl4dietazgutcj
 
 <img title='#f3f4f7' src='https://swatch.now.sh?color=%23f3f4f7&name=snow' /><img title='#f7f8fa' src='https://swatch.now.sh?color=%23f7f8fa&name=snow-muted' /><img title='#117eb3' src='https://swatch.now.sh?color=%23117eb3&name=link' />
 
-## Releasing
-
-First, clean and build the CSS and the docs.
-
-```console
-# Clean then build your local workspace
-$ npm run clean
-$ npm run build
-```
-
-Next, with IPFS running locally, add the docs to IPFS, to get the new CID.
-
-```console
-# Add the docs to IPFS to get the CID
-$ npm run -s deploy:docs
-QmQYzfzGKAeBWgarrmTSsG2PJ8AFfFEBprhVBFaudcFTof
-```
-
-Pin the CID to ipfs-cluster (via #pinbot on IRC or your preferred method). Update the README.md with the new docs link.
-
-Then bump the version, push to GitHub and publish to npm. If you are adding an icon, that's a minor release. Fixing an issue with an existing icon would be a patch. Changing any of the color values would be at least a minor. Changing the naming scheme for the CSS classes would be a major release.
+## License
 
-```console
-# use npm to bump the version and tag
-$ npm version minor
+Licensed under either of
 
-# Push the changes back to the repo
-$ git push origin master
-$ git push --tags
-
-# PUBLISH!
-$ npm publish
-```
+- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
 ## Contribute
 
-Contributions are more than welcome! Check out the [currently open issues](https://github.com/ipfs-shipyard/helia-css/issues) and start hacking on anything that sounds interesting. Issues are labeled with a variety of tags to help you find a good fit — you may wish to start with the [`help-wanted`](https://github.com/ipfs-shipyard/ipfs-share-files/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) tag.
-
-To contribute to IPFS in general, check out the wide variety of opportunities [here](https://docs.ipfs.io/community/contribute/ways-to-contribute).
-
-The IPFS community believes that our mission is best served in an environment that is friendly, safe, and accepting, and free from intimidation or harassment. To that end, we ask that everyone involved in IPFS read and respect our [code of conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
-
-## License
-
-The [Monserrat font family](https://github.com/JulietaUla/Montserrat) © The Montserrat Project Authors (https://github.com/JulietaUla/Montserrat) is used under the [SIL Open Font License, Version 1.1.](https://github.com/JulietaUla/Montserrat/blob/21047be7ebcae5e71328358fcf20566cb85383ec/OFL.txt)
+Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-ipfs-unixfs/issues).
 
-The [Inter font family](https://github.com/rsms/inter/blob/master/LICENSE.txt) © The Inter Project Authors (me@rsms.me) is used under the [SIL Open Font License, Version 1.1.](https://github.com/rsms/inter/blob/fa8a99377e8d51d6c0721a4b4c96d91911399dcf/LICENSE.txt)
+Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
 
-The home icon © Icons8 is under their [Free License](https://icons8.com/license)
+Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
 
-All other documents and icons are [CC-BY-SA 3.0] license © 2018 Protocol Labs Inc.
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
 
-Code is under the [MIT](./LICENSE) © 2018 Protocol Labs Inc.
+[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
 
 [ipfs.io]: https://ipfs.io
 [tachyons]: http://tachyons.io

diff --git a/package.json b/package.json
@@ -1,9 +1,107 @@
 {
-  "name": "helia-css",
+  "name": "@helia/css",
   "version": "0.0.0",
   "description": "The single-purpose css class names and @font-face config to Helia up your UI",
+  "license": "Apache-2.0 OR MIT",
+  "homepage": "https://github.com/ipfs-shipyard/helia-css#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ipfs-shipyard/helia-css.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ipfs-shipyard/helia-css/issues"
+  },
+  "engines": {
+    "node": ">=18.0.0",
+    "npm": ">=8.6.0"
+  },
   "main": "helia.css",
   "style": "helia.css",
+  "release": {
+    "branches": [
+      "main"
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits",
+          "releaseRules": [
+            {
+              "breaking": true,
+              "release": "major"
+            },
+            {
+              "revert": true,
+              "release": "patch"
+            },
+            {
+              "type": "feat",
+              "release": "minor"
+            },
+            {
+              "type": "fix",
+              "release": "patch"
+            },
+            {
+              "type": "docs",
+              "release": "patch"
+            },
+            {
+              "type": "test",
+              "release": "patch"
+            },
+            {
+              "type": "deps",
+              "release": "patch"
+            },
+            {
+              "scope": "no-release",
+              "release": false
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "presetConfig": {
+            "types": [
+              {
+                "type": "feat",
+                "section": "Features"
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes"
+              },
+              {
+                "type": "chore",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "docs",
+                "section": "Documentation"
+              },
+              {
+                "type": "deps",
+                "section": "Dependencies"
+              },
+              {
+                "type": "test",
+                "section": "Tests"
+              }
+            ]
+          }
+        }
+      ],
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      "@semantic-release/git"
+    ]
+  },
   "scripts": {
     "test": "stylelint **/*.css",
     "clean": "rm -rf ./docs/* ./fonts ./helia.css ./theme.scss ./vars.scss ./src/theme.css",
@@ -13,10 +111,9 @@
     "build:icons": "cp -a icons/. docs/icons/",
     "build:licenses": "cp src/fonts/inter/LICENSE.txt fonts/Inter-LICENSE.txt; cp src/fonts/montserrat/OFL.txt fonts/Montserrat-LICENSE.txt;",
     "build:docs": "node build/icons-page.js > docs/index.html",
-    "deploy:docs": "rsync -aq --delete icons docs/; ipfs add --cid-version 1 -r -Q docs"
+    "deploy:docs": "rsync -aq --delete icons docs/; ipfs add --cid-version 1 -r -Q docs",
+    "release": "aegir release"
   },
-  "author": "olizilla",
-  "license": "MIT",
   "devDependencies": {
     "aegir": "^39.0.6",
     "autoprefixer": "^10.4.8",
@@ -32,13 +129,5 @@
   },
   "directories": {
     "doc": "docs"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/ipfs-shipyard/helia-css.git"
-  },
-  "bugs": {
-    "url": "https://github.com/ipfs-shipyard/helia-css/issues"
-  },
-  "homepage": "https://github.com/ipfs-shipyard/helia-css#readme"
+  }
 }