update README.md

update .npmignore update sample index.html add build command package.json
4xmen · Feb 16, 2023 · 63704d7 · 63704d7
1 parent 17cdf1d
commit 63704d7
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 3 deletions.
diff --git a/.npmignore b/.npmignore
@@ -1 +1,3 @@
 *.png
+.idea
+.idea/*
diff --git a/README.md b/README.md
@@ -290,6 +290,20 @@ Contribution are always welcome and recommended! Here is how:
 
 [GPL](https://www.gnu.org/licenses/gpl-3.0.en.html)
 
+## Developing project
+
+Dependencies are `node-sass` and `minify`
+
+To render css:
+```shell
+npm run scss
+```
+
+To build:
+```shell
+npm run build
+```
+
 
 ## Support
 

diff --git a/example/index.html b/example/index.html
@@ -180,8 +180,8 @@ <h3>
             </a>
         </li>
         <li>
-            <a href="#">
-                menu item 3
+            <a href="https://github.com/4xmen/x-mega-menu">
+                Github
             </a>
         </li>
         <li>

diff --git a/package.json b/package.json
@@ -4,7 +4,8 @@
   "description": "vanilla javascript mega menu easy use",
   "main": "index.js",
   "scripts": {
-    "scss": "node-sass --watch src/x-mega-menu.scss -o dist"
+    "scss": "node-sass --watch src/x-mega-menu.scss -o dist",
+    "build": "node src/build.js"
   },
   "repository": {
     "type": "git",