Skip to content

Commit e7a5dfa

Browse files
authored
docs: improvements
1 parent 510c02f commit e7a5dfa

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,35 +5,35 @@
55
[![License][license-src]][license-href]
66
[![Nuxt][nuxt-src]][nuxt-href]
77

8-
Nuxt LLMs generates [`llms.txt` markdown documentation](https://llmstxt.org/) for your Nuxt application. It provides runtime hooks to gather the content from your application and generate documentation in a text format.
8+
Nuxt LLMs automatically generates [`llms.txt` markdown documentation](https://llmstxt.org/) for your Nuxt application. It provides runtime hooks to collect data from various sources (CMS, Nuxt Content, etc.) and generate structured documentation in a text-based format.
99

1010
- [ Release Notes](/CHANGELOG.md)
1111
<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/my-module?file=playground%2Fapp.vue) -->
1212
<!-- - [📖 &nbsp;Documentation](https://example.com) -->
1313

1414
## Features
1515

16-
- Generate `llms.txt` and `llms_full.txt` files
17-
- Customizable sections right from your `nuxt.config.ts`
18-
- Simple hooks to integrate with Nuxt modules and your application
16+
- Generates & prerenders `/llms.txt` and `/llms_full.txt` routes automatically
17+
- Customizable sections directly from your `nuxt.config.ts`
18+
- Integrates with Nuxt modules and your application via the runtime hooks system
1919

2020
## Quick Setup
2121

22-
Install module
22+
1. Install the module:
2323

2424
```bash
2525
npm i nuxt-llms
2626
```
2727

28-
Then, add nuxt-llms to the modules section of your nuxt.config.ts
28+
2. Register `nuxt-llms` in your `nuxt.config.ts`:
2929

3030
```ts
3131
export default defineNuxtConfig({
3232
modules: ['nuxt-llms']
3333
})
3434
```
3535

36-
Add application domain and provide information about the application
36+
3. Configure your application details:
3737

3838
```ts
3939
export default defineNuxtConfig({

0 commit comments

Comments
 (0)