Skip to content

Commit 3a05adb

Browse files
committed
doc: sync
1 parent d8d715d commit 3a05adb

File tree

2 files changed

+40
-54
lines changed

2 files changed

+40
-54
lines changed

LICENSE.md

+4-16
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,9 @@
11
MIT License
22

3-
Copyright (c) 2024 Harlan Wilton <https://github.com/harlan-zw>
3+
Copyright (c) 2024 Harlan Wilton
44

5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
116

12-
The above copyright notice and this permission notice shall be included in all
13-
copies or substantial portions of the Software.
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
148

15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
9+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

+36-38
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,46 @@
1-
<h1 align='center'>Nuxt SEO</h1>
1+
<h1>@nuxtjs/seo</h1>
22

3-
<p align="center">
4-
<a href='https://github.com/harlan-zw/nuxt-seo/actions/workflows/test.yml'>
5-
</a>
6-
<a href="https://www.npmjs.com/package/@nuxtjs/seo" target="__blank"><img src="https://img.shields.io/npm/v/@nuxtjs/seo?style=flat&colorA=002438&colorB=28CF8D" alt="NPM version"></a>
7-
<a href="https://www.npmjs.com/package/@nuxtjs/seo" target="__blank"><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/@nuxtjs/seo?flat&colorA=002438&colorB=28CF8D"></a>
8-
<a href="https://github.com/harlan-zw/nuxt-seo" target="__blank"><img alt="GitHub stars" src="https://img.shields.io/github/stars/harlan-zw/nuxt-seo?flat&colorA=002438&colorB=28CF8D"></a>
9-
</p>
3+
[![npm version][npm-version-src]][npm-version-href]
4+
[![npm downloads][npm-downloads-src]][npm-downloads-href]
5+
[![License][license-src]][license-href]
6+
[![Nuxt][nuxt-src]][nuxt-href]
107

11-
<p align="center">
12-
The complete SEO solution for Nuxt.
13-
</p>
8+
The Nuxt SEO module is an all-in-one SEO solution for Nuxt. It combines 6 SEO modules and best practices into one module that requires minimal effort to configure.
9+
10+
## Modules
11+
12+
- 🤖 [@nuxtjs/robots](https://github.com/nuxt-modules/robots) - Manage site crawling
13+
- 📄 [@nuxtjs/sitemap](https://github.com/nuxt-modules/sitemap) - Sitemap.xml Support
14+
- 🔎 [nuxt-schema-org](https://github.com/harlan-zw/nuxt-schema-org) - Generate Schema.org JSON-LD for SEO
15+
-[nuxt-seo-utils](https://github.com/harlan-zw/nuxt-seo-utils) - Experimental SEO meta features
16+
- 🖼️ [nuxt-og-image](https://github.com/nuxt-modules/og-image) - Generate dynamic social share images
17+
-[nuxt-link-checker](https://github.com/harlan-zw/nuxt-link-checker) - Check for broken links
1418

1519
<p align="center">
1620
<table>
1721
<tbody>
1822
<td align="center">
19-
<img width="800" height="0" /><br>
20-
<i>Status:</i> <a href="https://github.com/harlan-zw/nuxt-seo/releases/tag/v2.0.0">v2 RC is available</a></b> <br>
21-
<sup> Please report any issues 🐛</sup><br>
2223
<sub>Made possible by my <a href="https://github.com/sponsors/harlan-zw">Sponsor Program 💖</a><br> Follow me <a href="https://twitter.com/harlan_zw">@harlan_zw</a> 🐦 • Join <a href="https://discord.gg/275MBUBvgP">Discord</a> for help</sub><br>
23-
<img width="800" height="0" />
2424
</td>
2525
</tbody>
2626
</table>
2727
</p>
2828

29-
## Background
30-
31-
Technical SEO is hard. It requires many moving parts that need to work well together. Configuring all of these parts
32-
correctly is a challenge.
33-
34-
Nuxt SEO is the total SEO solution for Nuxt. It combines 7 SEO modules and best practices into one module that requires
35-
minimal effort to configure.
3629

37-
With powerful APIs built for fully dynamic sites and zero-config defaults for static sites.
30+
## Installation
3831

39-
## Modules
40-
41-
- 📖 [@nuxtjs/sitemap](https://github.com/nuxt-modules/sitemap) - Sitemap.xml Support
42-
- 🤖 [@nuxtjs/robots](https://github.com/nuxt-modules/robots) - Manage site crawling
43-
- 🔎 [nuxt-schema-org](https://github.com/harlan-zw/nuxt-schema-org) - Generate Schema.org JSON-LD for SEO
44-
-[nuxt-seo-utils](https://github.com/harlan-zw/nuxt-seo-utils) - Experimental SEO meta features
45-
- 🖼️ [nuxt-og-image](https://github.com/nuxt-modules/og-image) - Generate dynamic social share images
46-
-[nuxt-link-checker](https://github.com/harlan-zw/nuxt-link-checker) - Check for broken links
47-
48-
## Install
49-
50-
1. Install `@nuxtjs/seo` dependency to your project:
32+
Install `@nuxtjs/seo` dependency to your project:
5133

5234
```sh
5335
npx nuxi@latest module add seo
5436
```
5537

56-
That's it!
38+
Once installed check the [Default Module Features](https://nuxtseo.com/docs/nuxt-seo/guides/using-the-modules) guide
39+
for a quick start.
5740

58-
All features are enabled by default. Learn more by exploring the [documentation](https://nuxtseo.com)
41+
## Documentation
42+
43+
[📖 Read the full documentation](https://nuxtseo.com/) for more information.
5944

6045
## Stackblitz
6146

@@ -72,4 +57,17 @@ template.
7257

7358
## License
7459

75-
MIT License © 2022-PRESENT [Harlan Wilton](https://github.com/harlan-zw)
60+
Licensed under the [MIT license](https://github.com/harlan-zw/nuxt-seo/blob/main/LICENSE.md).
61+
62+
<!-- Badges -->
63+
[npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/seo/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
64+
[npm-version-href]: https://npmjs.com/package/@nuxtjs/seo
65+
66+
[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxtjs/seo.svg?style=flat&colorA=18181B&colorB=28CF8D
67+
[npm-downloads-href]: https://npmjs.com/package/@nuxtjs/seo
68+
69+
[license-src]: https://img.shields.io/github/license/harlan-zw/nuxt-seo.svg?style=flat&colorA=18181B&colorB=28CF8D
70+
[license-href]: https://github.com/harlan-zw/nuxt-seo/blob/main/LICENSE.md
71+
72+
[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
73+
[nuxt-href]: https://nuxt.com

0 commit comments

Comments
 (0)