Skip to content

Commit 5071026

Browse files
authored
docs: update readme
1 parent 560bcfc commit 5071026

File tree

1 file changed

+58
-11
lines changed

1 file changed

+58
-11
lines changed

README.md

Lines changed: 58 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ CLI to analyze a website and detect Vue and its ecosystem ✨
44

55
This module is used by [vuetelemetry.com](https://vuetelemetry.com) to detect Vue and its ecosystem on a website.
66

7-
You can help the community by using the [browser extension](https://github.com/nuxt-company/vue-telemetry-extensions) 💚
7+
You can help the community discover new Vue websites by using the [browser extension](https://github.com/nuxt-company/vue-telemetry-extensions) 💚
88

99
## Installation
1010

@@ -103,26 +103,73 @@ Result:
103103
meta: {
104104
language: 'en',
105105
title: 'Nuxt.js - The Vue.js Framework',
106-
description: 'Nuxt.js presets all the configuration needed to make...'
106+
description: 'Nuxt.js presets all the configuration needed to make...',
107+
siteName: 'NuxtJS',
108+
isAdultContent: false
107109
},
108110
vueVersion: '2.6.11',
109-
// Vue Framework
110-
framework: 'nuxt',
111111
hasSSR: true,
112112
isStatic: true,
113+
// Vue Framework
114+
framework: {
115+
slug: 'nuxtjs',
116+
name: 'NuxtJS',
117+
imgPath: '/framework/nuxt.svg', // prefix with https://icons.vuetelemetry.com
118+
},
113119
// Vue plugins
114120
plugins: [
115-
'vue-router',
116-
'vue-meta',
117-
'vuex'
121+
{
122+
slug: 'vue-router',
123+
name: 'vue-router',
124+
imgPath: null,
125+
url: 'https://router.vuejs.org/'
126+
},
127+
{
128+
slug: 'vue-meta',
129+
name: 'vue-meta',
130+
imgPath: null,
131+
url: 'https://vue-meta.nuxtjs.org'
132+
},
133+
{
134+
slug: 'vuex',
135+
name: 'vuex',
136+
imgPath: null,
137+
url: 'https://vuex.vuejs.org'
138+
}
118139
],
119140
// UI Librairy
120-
ui: 'tailwindcss',
141+
ui: {
142+
slug: 'tailwind-css',
143+
name: 'Tailwind CSS',
144+
imgPath: '/ui/tailwind.svg',
145+
url: 'https://tailwindcss.com/'
146+
},
121147
// Framework modules
122148
frameworkModules: [
123-
'@nuxt/http',
124-
'@nuxtjs/pwa',
125-
'@nuxtjs/google-analytics'
149+
{
150+
slug: 'nuxt-http',
151+
name: '@nuxt/http',
152+
imgPath: null,
153+
url: 'https://http.nuxtjs.org'
154+
},
155+
{
156+
slug: 'nuxtjs-pwa',
157+
name: '@nuxtjs/pwa',
158+
imgPath: null,
159+
url: 'https://pwa.nuxtjs.org/'
160+
},
161+
{
162+
slug: 'nuxtjs-google-analytics',
163+
name: '@nuxtjs/google-analytics',
164+
imgPath: null,
165+
url: 'https://github.com/nuxt-community/analytics-module'
166+
},
167+
{
168+
slug: 'nuxtjs-color-mode',
169+
name: '@nuxtjs/color-mode',
170+
imgPath: null,
171+
url: 'https://github.com/nuxt-community/color-mode-module'
172+
}
126173
],
127174
screenshot: '/var/folders/....../8f1a071384d0b4.jpg'
128175
}

0 commit comments

Comments
 (0)