Skip to content

Commit a30fbf7

Browse files
committed
updated docs
1 parent fc6f161 commit a30fbf7

File tree

3 files changed

+6
-48
lines changed

3 files changed

+6
-48
lines changed

README.md

Lines changed: 6 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,15 @@
1-
# laravel-dashboard-npm
2-
> Show npm packages stats
1+
# laravel-dashboard-packagist
2+
> Show Packagist package stats
33
44

55
## Installation
66
You can install the package via composer:
77
```
8-
composer require skydiver/laravel-dashboard-npm
8+
composer require skydiver/laravel-dashboard-packagist
99
```
1010

1111

12-
## npm package tile
13-
```
14-
<x-dashboard>
15-
<livewire:npm-package-tile
16-
position="e1"
17-
package="vue"
18-
type="last-week"
19-
cache-timeout="60"
20-
:force-refresh="false"
21-
:show-logo="true"
22-
/>
23-
</x-dashboard>
24-
```
25-
26-
27-
## npm packages table tile
28-
```
29-
<x-dashboard>
30-
<livewire:npm-packages-table-tile
31-
position="e1"
32-
packages="vue,react,jquery"
33-
type="last-week"
34-
cache-timeout="60"
35-
:force-refresh="false"
36-
:show-logo="false"
37-
/>
38-
</x-dashboard>
39-
```
40-
41-
## Shared options
42-
| Option | Description | Valid Options | Default |
43-
|---------------|-------------------------------------------------------|---------------------------------|------------|
44-
| type | type of download | last-day, last-week, last-month | last-month |
45-
| cache-timeout | seconds to refresh package info | - | 600 |
46-
| force-refresh | force refrsh package info (useful during development) | true, false | false |
47-
| show-logo | show npm logo at top right conrner | true, false | true |
48-
49-
50-
## Demo
51-
* npm-package-tile
52-
53-
![npm-package-tile](demo/npm-package-tile.png)
54-
55-
* npm-packages-table-tile
12+
## Where are the docs?
13+
This package is for internal use, but feel free to include on your dashboard.
5614

57-
![npm-packages-table-tile](demo/npm-packages-table-tile.png)
15+
Works similar to https://github.com/skydiver/laravel-dashboard-npm.

demo/npm-package-tile.png

-17.3 KB
Binary file not shown.

demo/npm-packages-table-tile.png

-18.7 KB
Binary file not shown.

0 commit comments

Comments
 (0)