Changed library name from tool-tipsy to yk-tool-tipsy

yassine-klilich · Jun 21, 2023 · c050a7e · c050a7e
1 parent be537d9
commit c050a7e
Show file tree

Hide file tree

Showing 9 changed files with 18 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -1,16 +1,16 @@
-# Tool-Tipsy
+# YK-Tool-Tipsy
 
-Tool-Tipsy is a lightweight tooltip library.
+YK-Tool-Tipsy is a lightweight tooltip library.
 
 # Installation
 
 ```
-npm install tool-tipsy
+npm install yk-tool-tipsy
 ```
 
 # How to use
 
-- tool-tipsy consists of 4 attributes:
+- YK-Tool-Tipsy consists of 4 attributes:
 ```html
 <button
   tipsy="Hello Universe!"
@@ -29,7 +29,7 @@ tipsy-hide-after       | milliseconds
 
 - And in your JS file import the library and call init function to inilitialize your tooltips that has been defined in HTML.
 ```javascript
-import Tipsy from "tool-tipsy"
+import Tipsy from "yk-tool-tipsy"
 
 Tipsy.init()
 ```
@@ -77,6 +77,8 @@ Tipsy.tooltips['tipsy-0'].hideAfter = 800
 # References
 - Tooltip positions
 ```javascript
+import { TipsyPosition } from "yk-tool-tipsy"
+
 TipsyPosition.above
 TipsyPosition.below
 TipsyPosition.left

diff --git a/dist/tool-tipsy.css → dist/yk-tool-tipsy.css b/dist/tool-tipsy.css → dist/yk-tool-tipsy.css
diff --git a/dist/tool-tipsy.js → dist/yk-tool-tipsy.js b/dist/tool-tipsy.js → dist/yk-tool-tipsy.js
@@ -1,4 +1,4 @@
-import "./tool-tipsy.css"
+import "./yk-tool-tipsy.css"
 
 const Tipsy = (function() {
   const DEFAULT_SHOW_AFTER = 150

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,23 +1,23 @@
 {
-  "name": "tool-tipsy",
+  "name": "yk-tool-tipsy",
   "version": "1.0.0",
   "description": "A lightweight tooltip library",
-  "main": "./dist/tool-tipsy.js",
+  "main": "./dist/yk-tool-tipsy.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "webpack --config webpack.prod.js",
     "start": "webpack server --config webpack.config.js --open"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/yassine-klilich/tool-tipsy.git"
+    "url": "git+https://github.com/yassine-klilich/yk-tool-tipsy.git"
   },
   "author": "Yassine KLILICH",
   "license": "ISC",
   "bugs": {
-    "url": "https://github.com/yassine-klilich/tool-tipsy/issues"
+    "url": "https://github.com/yassine-klilich/yk-tool-tipsy/issues"
   },
-  "homepage": "https://github.com/yassine-klilich/tool-tipsy#readme",
+  "homepage": "https://github.com/yassine-klilich/yk-tool-tipsy#readme",
   "devDependencies": {
     "css-loader": "^6.7.1",
     "css-minimizer-webpack-plugin": "^4.2.2",

diff --git a/src/script.js b/src/script.js
@@ -1,5 +1,5 @@
 
-import Tipsy, { TipsyPosition } from "./tool-tipsy.js"
+import Tipsy, { TipsyPosition } from "./yk-tool-tipsy.js"
 
 Tipsy.init()
 

diff --git a/src/tool-tipsy.css → src/yk-tool-tipsy.css b/src/tool-tipsy.css → src/yk-tool-tipsy.css
diff --git a/src/tool-tipsy.js → src/yk-tool-tipsy.js b/src/tool-tipsy.js → src/yk-tool-tipsy.js
@@ -1,4 +1,4 @@
-import "./tool-tipsy.css"
+import "./yk-tool-tipsy.css"
 
 const Tipsy = (function() {
   const DEFAULT_SHOW_AFTER = 150

diff --git a/webpack.config.js b/webpack.config.js
@@ -4,7 +4,7 @@ const MiniCssExtractPlugin = require("mini-css-extract-plugin");
 module.exports = {
   mode: "development",
   entry: {
-    "tool-tipsy": "./src/tool-tipsy.js",
+    "yk-tool-tipsy": "./src/yk-tool-tipsy.js",
     script: "./src/script.js"
   },
   module: {