@rmacshane-lw/slugify-lite 1.0.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +12 -0
  2. package/index.d.ts +6 -0
  3. package/package.json +3 -2
package/README.md CHANGED
@@ -2,7 +2,19 @@
2
2
 
3
3
  A tiny utility that converts strings into URL-friendly slugs.
4
4
 
5
+ **Note:** This is just an AI generated package that is used for me to test npm package management. Use at your own risk.
6
+
5
7
  ## Installation
6
8
 
7
9
  ```bash
8
10
  npm install slugify-lite
11
+ ```
12
+
13
+ ## Usage
14
+
15
+ ```typescript
16
+ import { slugify } from '@rmacshane-lw/slugify-lite';
17
+
18
+ const slug = slugify('Hello World');
19
+ console.log(slug); # hello-world
20
+ ```
package/index.d.ts ADDED
@@ -0,0 +1,6 @@
1
+ /**
2
+ * A tiny function to slugify strings for URLs
3
+ * @param text - The text to convert into a URL-friendly slug
4
+ * @returns A URL-friendly string with spaces replaced by hyphens and special characters removed
5
+ */
6
+ export function slugify(text: string): string;
package/package.json CHANGED
@@ -1,9 +1,10 @@
1
1
  {
2
2
  "name": "@rmacshane-lw/slugify-lite",
3
- "version": "1.0.0",
4
- "description": "A tiny function to slugify strings for URLs",
3
+ "version": "2.0.0",
4
+ "description": "A tiny function to slugify strings for URLs - This is a test package for me to test npm version management - Use at your own risk!",
5
5
  "main": "index.js",
6
6
  "type": "module",
7
+ "types": "index.d.ts",
7
8
  "publishConfig": {
8
9
  "access": "public"
9
10
  },