@hasna/skills 0.1.33 → 0.1.34

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.
@@ -1,111 +0,0 @@
1
- # Quick Start Guide
2
-
3
- Get started with the Image Generation Skill in 3 easy steps.
4
-
5
- ## Step 1: Set up API Keys
6
-
7
- Copy the example environment file and add your API keys:
8
-
9
- ```bash
10
- cp .env.example .env
11
- # Edit .env with your favorite editor and add your API keys
12
- ```
13
-
14
- Or export them directly:
15
-
16
- ```bash
17
- export OPENAI_API_KEY="sk-..."
18
- export GEMINI_API_KEY="..."
19
- export GOOGLE_PROJECT_ID="your-project-id"
20
- export XAI_API_KEY="..."
21
- ```
22
-
23
- ## Step 2: Generate Your First Image
24
-
25
- Choose a provider and run:
26
-
27
- ```bash
28
- # OpenAI
29
- bun run src/index.ts generate \
30
- --provider openai \
31
- --prompt "a beautiful sunset over mountains" \
32
- --output ./my-first-image.png
33
-
34
- # Google
35
- bun run src/index.ts generate \
36
- --provider google \
37
- --prompt "a beautiful sunset over mountains" \
38
- --output ./my-first-image.png
39
-
40
- # xAI
41
- bun run src/index.ts generate \
42
- --provider xai \
43
- --prompt "a beautiful sunset over mountains" \
44
- --output ./my-first-image.png
45
- ```
46
-
47
- ## Step 3: Explore Advanced Options
48
-
49
- ### Custom Sizes
50
-
51
- OpenAI sizes:
52
- ```bash
53
- bun run src/index.ts generate \
54
- -p openai \
55
- --prompt "wide landscape" \
56
- -o ./landscape.png \
57
- --size 1792x1024
58
- ```
59
-
60
- Google aspect ratios:
61
- ```bash
62
- bun run src/index.ts generate \
63
- -p google \
64
- --prompt "portrait photo" \
65
- -o ./portrait.png \
66
- --size 3:4
67
- ```
68
-
69
- ### Run Example Scripts
70
-
71
- ```bash
72
- cd examples
73
- ./openai-examples.sh
74
- ./google-examples.sh
75
- ./xai-examples.sh
76
- ```
77
-
78
- ## Tips
79
-
80
- 1. **Prompt Engineering**: Be specific and descriptive in your prompts
81
- 2. **Size Selection**: Choose the right size for your use case
82
- - Square (1024x1024, 1:1): Social media posts, avatars
83
- - Landscape (1792x1024, 16:9): Banners, headers
84
- - Portrait (1024x1792, 9:16): Mobile wallpapers, stories
85
- 3. **Provider Selection**:
86
- - OpenAI: Great for detailed, creative images
87
- - Google: Best for photorealistic results
88
- - xAI: Excellent for artistic interpretation
89
-
90
- ## Troubleshooting
91
-
92
- ### "API key required" error
93
- Make sure your environment variables are set correctly.
94
-
95
- ### "Invalid size" error
96
- Check the provider-specific size options in the help:
97
- ```bash
98
- bun run src/index.ts --help
99
- ```
100
-
101
- ### Image quality issues
102
- Try being more specific in your prompt or experiment with different providers.
103
-
104
- ## Next Steps
105
-
106
- - Read the full [README.md](README.md) for detailed documentation
107
- - Check [SKILL.md](SKILL.md) for skill metadata
108
- - Explore the [examples/](examples/) directory for more use cases
109
- - Review [src/](src/) for implementation details
110
-
111
- Happy image generation!
@@ -1,10 +0,0 @@
1
- # At least one provider API key is required
2
-
3
- # ElevenLabs - Highest accuracy (96.7%), 3GB files, speaker diarization
4
- ELEVENLABS_API_KEY=your_elevenlabs_key
5
-
6
- # OpenAI Whisper - Industry standard, 25MB limit (auto-chunking for larger)
7
- OPENAI_API_KEY=your_openai_key
8
-
9
- # Google Gemini - Cost-effective, 2GB files, generous free tier
10
- GOOGLE_API_KEY=your_google_key
@@ -1,2 +0,0 @@
1
- # Firecrawl API key (required)
2
- FIRECRAWL_API_KEY=fc-your-api-key-here