llmstxt - npm Package Compare versions

Comparing version 0.4.0 to 0.4.1

LICENSE

+BSD 3-Clause License
+
+Copyright (c) 2024, Scott Motte
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package.json

 {
-  "version": "0.4.0",
+  "version": "0.4.1",
   "name": "llmstxt",
@@ -4,0 +4,0 @@ "description": "convert `sitemap.xml` to `llms.txt`",

README.md

@@ -10,7 +10,4 @@ # llmstxt
 ```sh
-$ npm install llmstxt -g
+$ npx llmstxt gen https://dotenvx.com/sitemap.xml
 ```
-```sh
-$ llmstxt gen https://dotenvx.com/sitemap.xml
-```
 
@@ -20,3 +17,3 @@ * <details><summary>expand example</summary><br>
   ```
-  $ llmstxt gen https://dotenvx.com/sitemap.xml
+  $ npx llmstxt gen https://dotenvx.com/sitemap.xml
   - [dotenvx run -f](https://dotenvx.com/docs/advanced/run-f.html): Compose multiple .env files for environment variables loading, as you need.
@@ -105,1 +102,11 @@ - [dotenvx run --log-level](https://dotenvx.com/docs/advanced/run-log-level.html): Set `--log-level` to whatever you wish.
 &nbsp;
+
+## FAQ
+
+#### Can you give me a real world example?
+
+I'm using it to generate [dotenvx.com/llms.txt](https://dotenvx.com/llms.txt) with the following command:
+
+```sh
+npx llmstxt gen https://dotenvx.com/sitemap.xml -ep "**/privacy**" -ep "**/terms**" -ep "**/blog/**" -ep "**/stats/**" -ep "**/support/**" -rt 's/\| dotenvx//' > llms.txt
+```

src/cli/actions/gen.js

@@ -85,3 +85,3 @@ const cheerio = require('cheerio')
   // replaceTitle logic
-  const replaceTitle = options.replaceTitle
+  const replaceTitle = options.replaceTitle || []
 
@@ -88,0 +88,0 @@ let lines = []

No alert changes

Improved metrics

Total package byte prevSize

10145

21.83%

Number of package files

6

20%

Number of lines in readme file

110

6.8%

No dependency changes