nes.css - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "nes.css",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "NES.css is NES-style CSS Framework.",
@@ -32,3 +32,2 @@ "scripts": {
   "homepage": "https://github.com/BcRikko/NES.css#readme",
-  "main": "./scss/nes.scss",
   "devDependencies": {
@@ -41,7 +40,9 @@ "autoprefixer": "^9.1.5",
     "postcss-cli": "^6.0.0",
-    "prettier-stylelint": "^0.4.2",
+    "prettier": "^1.15.2",
     "rimraf": "^2.6.2",
     "stylelint": "^9.5.0",
+    "stylelint-config-prettier": "^4.0.0",
     "stylelint-config-recess-order": "^2.0.0",
     "stylelint-config-standard": "^18.2.0",
+    "stylelint-prettier": "^1.0.5",
     "stylelint-scss": "^3.3.1"
@@ -64,5 +65,9 @@ },
   },
+  "prettier": {
+    "printWidth": 100
+  },
   "stylelint": {
     "plugins": [
-      "stylelint-scss"
+      "stylelint-scss",
+      "stylelint-prettier"
     ],
@@ -72,5 +77,6 @@ "extends": [
       "stylelint-config-recess-order",
-      "./node_modules/prettier-stylelint/config.js"
+      "stylelint-prettier/recommended"
     ],
     "rules": {
+      "prettier/prettier": true,
       "string-quotes": "double",
@@ -77,0 +83,0 @@ "at-rule-no-unknown": null,

README.md

@@ -1,6 +0,60 @@
-# NES.css
+<div align="center">
+  <a href="https://bcrikko.github.io/NES.css/" target="_blank"><img src="https://user-images.githubusercontent.com/5305599/49061716-da649680-f254-11e8-9a89-d95a7407ec6a.png" alt="NES.css: NES-style  CSS framework" style="max-width:100%;" width="600" height="315"></a>
 
-`NES.css` is NES-style(8bit-like) CSS Framework.  
-`NES.css`はファミコン風 CSS フレームワークです。
+  <a href="README.md">English</a> / <a href="README.md">日本語</a>
+</div>
 
-![8bit](https://user-images.githubusercontent.com/5305599/45937791-a5db2100-bffe-11e8-8bfd-fc3f534b28aa.gif)
+NES.css is a **NES-style(8bit-like)** CSS Framework.  
+NES.cssは **ファミコン風(8bit ライク)** なCSSフレームワークです。
+
+
+## Install
+
+### CDN
+
+```html
+<!-- minify -->
+<link href="https://bcrikko.github.io/NES.css/css/nes.min.css" rel="stylesheet" />
+```
+
+OR
+
+```html
+<!-- non-minified -->
+<link href="https://bcrikko.github.io/NES.css/css/nes.css" rel="stylesheet" />
+```
+
+### npm
+
+TODO: npm での使用方法を書く
+
+
+## Usage
+
+NES.cssはコンポーネントのスタイルのみを提供しています。レイアウトはみなさんが好きなように定義してください。
+
+デフォルトでは`Press Start 2P`フォントを使っています。英語以外（日本語など）で利用される場合は、別途フォントを読み込んで使ってください。
+
+TODO: 詳細を書く
+
+
+## CSS Only
+
+NES.cssはCSSのみで構成されています。JavaScriptは不要です。
+
+
+## Browser Support
+
+次のブラウザの最新バージョンをサポートしています。
+
+* Chrome
+* Firefox
+* Safari
+
+未確認
+* IE/Edge
+
+
+## Copyright and license
+
+Code and documentation copyright 2018 [B.C.Rikko](https://github.com/BcRikko). Code released under the MIT License. Docs released under Creative Commons.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

255507

increased by20.53%

Number of package files

40

increased by8.11%

Lines of code

1165

increased by9.29%

Number of lines in readme file

61

increased by771.43%

Worsened metrics

Dev dependency count

14

increased by16.67%

No dependency changes