@waynesutton/convex-skills 1.0.0 → 1.0.1

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 (2) hide show
  1. package/README.md +44 -8
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,4 +1,7 @@
1
- # Convex (unoffical) Skills v1
1
+ # Convex (unofficial) Skills v1
2
+
3
+ [![npm version](https://img.shields.io/npm/v/@waynesutton/convex-skills.svg)](https://www.npmjs.com/package/@waynesutton/convex-skills)
4
+ [![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
2
5
 
3
6
  A collection of AI-consumable skills for building production-ready applications with [Convex](https://convex.dev), following the Agent Skills open format.
4
7
 
@@ -8,21 +11,53 @@ This repository contains skills that help AI assistants understand and implement
8
11
 
9
12
  ## Installation
10
13
 
11
- ### Claude Code (via Marketplace)
14
+ ### npm (recommended)
15
+
16
+ ```bash
17
+ # Install globally for CLI access
18
+ npm install -g @waynesutton/convex-skills
19
+
20
+ # List available skills
21
+ convex-skills list
22
+
23
+ # Install a specific skill to your project
24
+ convex-skills install convex-best-practices
25
+
26
+ # Install all skills
27
+ convex-skills install-all
28
+
29
+ # Install templates (CLAUDE.md + skill templates)
30
+ convex-skills install-templates
31
+ ```
32
+
33
+ Or use npx without installing:
34
+
35
+ ```bash
36
+ npx @waynesutton/convex-skills list
37
+ npx @waynesutton/convex-skills install-all
38
+ ```
39
+
40
+ ### Programmatic Usage
12
41
 
13
42
  ```bash
14
- # Add the marketplace
15
- claude plugin marketplace add get-convex/skills
43
+ npm install @waynesutton/convex-skills
44
+ ```
45
+
46
+ ```javascript
47
+ import { listSkills, getSkill, SKILLS } from "@waynesutton/convex-skills";
48
+
49
+ // List all skills
50
+ console.log(listSkills());
16
51
 
17
- # Install the plugin
18
- claude plugin install convex-skills
52
+ // Get a specific skill's content
53
+ const content = getSkill("convex-best-practices");
19
54
  ```
20
55
 
21
56
  ### Claude Code (from local clone)
22
57
 
23
58
  ```bash
24
- git clone https://github.com/get-convex/skills.git
25
- cd skills
59
+ git clone https://github.com/waynesutton/convexskills.git
60
+ cd convexskills
26
61
  # Point Claude Code to this directory
27
62
  ```
28
63
 
@@ -216,6 +251,7 @@ Apache-2.0 License - see [LICENSE](LICENSE) for details.
216
251
 
217
252
  ## References
218
253
 
254
+ - [npm Package](https://www.npmjs.com/package/@waynesutton/convex-skills)
219
255
  - [Convex Documentation](https://docs.convex.dev/)
220
256
  - [Convex LLMs.txt](https://docs.convex.dev/llms.txt)
221
257
  - [Agent Skills Specification](https://github.com/anthropics/skills)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@waynesutton/convex-skills",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Agent skills for building production-ready Convex applications. Includes best practices, functions, realtime patterns, schema validation, file storage, security audits, and more.",
5
5
  "author": "Wayne Sutton",
6
6
  "license": "Apache-2.0",