angular-custom-tour - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

package.json

@@ -8,3 +8,3 @@ {
   },
-  "version": "0.0.2",
+  "version": "0.0.3",
   "license": "MIT",
@@ -26,4 +26,3 @@ "main": "bundles/angular-custom-tour.umd.min.js",
   },
-  "dependencies": {
-  },
+  "dependencies": {},
   "devDependencies": {
@@ -42,3 +41,2 @@ "@angular/common": "^4.0.3",
     "angular2-template-loader": "^0.6.2",
-    "ts-loader": "~2.0.3",
     "codelyzer": "~3.0.0",
@@ -51,4 +49,5 @@ "core-js": "^2.4.1",
     "style-loader": "^0.16.1",
+    "ts-loader": "~2.0.3",
     "tslint": "^5.1.0",
-    "typescript": "2.2.2",
+    "typescript": "^2.2.2",
     "typescript-formatter": "^5.1.3",
@@ -55,0 +54,0 @@ "webpack": "~2.4.1",

README.md

 # Will be available later
-
+[![Build Status](https://img.shields.io/travis/miraxes/angular-custom-tour.svg?style=flat-square)](https://travis-ci.org/miraxes/angular-custom-tour)
+[![Downloads](https://img.shields.io/npm/dt/angular-custom-tour.svg?style=flat-square)](https://www.npmjs.com/package/angular-custom-tour)
 [![Versions](https://img.shields.io/npm/v/angular-custom-tour.svg?style=flat-square)]()
 [![License](https://img.shields.io/npm/l/angular-custom-tour.svg?style=flat-square)]()
 # demo
-  [https://miraxes.github.io/angular-custom-tour app](https://miraxes.github.io/angular-custom-tour app)
+  [https://miraxes.github.io/angular-custom-tour](https://miraxes.github.io/angular-custom-tour)
+
+
+# Custom tour with Angular 2.x.x
+
+# Usage
+
+  * install `npm install angular-custom-tour --save`
+
+  ```typescript
+  import { HintService } from '???'
+
+  class AppComponent {
+
+    constructor(public hintService: HintService){ }
+
+    startTour() {
+      this.hintService.initialize();
+    }
+
+  }
+  ```
+
+  ```html
+  <!-- Bluring element insert on top of the page-->
+  <fwyl-hint></fwyl-hint>
+
+  <!-- start TOUR -->
+  <button name="button" (click)="startTour()"> START!</button>
+
+  <!-- Each step could be placed at ANYWHERE -->
+  <div class="i-want-highlight-this" id="highlight-me"> WOW!</div>
+
+  <fwyl-intro-tour selector="highlight-me" order="3" position="right" title="title string">
+    <!-- ANY HTML HERE
+      NOTE: ONLY selector attribute is required! others is up to you
+    -->
+  </fwyl-intro-tour>
+  ```

tsconfig.json

 {
-  "compilerOptions": {
-    "target": "es5",
-    "module": "es2015",
-    "emitDecoratorMetadata": true,
-    "experimentalDecorators": true,
-    "sourceMap": true,
-    "noUnusedLocals": true,
-    "moduleResolution": "node",
-    "baseUrl": "./src",
-    "paths": {},
-    "lib": [
-      "es2015",
-      "dom"
+    "compilerOptions": {
+        "noImplicitAny": true,
+        "module": "commonjs",
+        "target": "ES5",
+        "emitDecoratorMetadata": true,
+        "experimentalDecorators": true,
+        "sourceMap": true,
+        "declaration": true
+    },
+    "files": [
+        "index.ts"
     ],
-    "types": [
-      "core-js",
-      "node",
-      "webpack"
+    "exclude": [
+        "node_modules"
     ]
-  },
-  "exclude": [
-    "node_modules"
-  ],
-  "angularCompilerOptions": {
-    "strictMetadataEmit": true,
-    "skipTemplateCodegen": true
-  },
-  "compileOnSave": false,
-  "buildOnSave": false,
-  "atom": {
-    "rewriteTsconfig": false
-  }
 }

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

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

33430

increased by316.83%

Number of package files

30

increased by200%

Lines of code

573

increased by402.63%

Number of lines in readme file

46

increased by557.14%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes