Ansa12 commited on
Commit
e92910a
Β·
verified Β·
1 Parent(s): 361ae81

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +31 -0
README.md CHANGED
@@ -8,5 +8,36 @@ sdk_version: 6.0.0
8
  app_file: app.py
9
  pinned: false
10
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
11
 
12
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
8
  app_file: app.py
9
  pinned: false
10
  ---
11
+ # StoryTime AI πŸŽͺ
12
+
13
+ A magical story generator for children that creates age-appropriate stories with morals.
14
+
15
+ ## Features
16
+
17
+ - πŸ“š **Age-appropriate stories**: Tailored for children aged 3-12
18
+ - 🎭 **Multiple themes**: Adventure, Animals, Fantasy, and more!
19
+ - 🌍 **Multi-language support**: English and Urdu
20
+ - πŸ”Š **Text-to-speech**: Listen to stories with audio narration
21
+ - 🎨 **Child-friendly interface**: Colorful and engaging design
22
+
23
+ ## Setup
24
+
25
+ 1. Get a Groq API key from [https://console.groq.com](https://console.groq.com)
26
+ 2. Add your API key as a secret in Hugging Face Space settings:
27
+ - Go to Settings β†’ Repository secrets
28
+ - Add new secret: `GROQ_API_KEY` = your_api_key_here
29
+
30
+ ## How to Use
31
+
32
+ 1. Select the child's age (3-12 years)
33
+ 2. Choose a story theme
34
+ 3. Select preferred language (English or Urdu)
35
+ 4. Toggle audio option if you want speech
36
+ 5. Click "Create Magical Story!"
37
+ 6. Read and listen to your custom story!
38
+
39
+ ## Deployment
40
+
41
+ This app is deployed on Hugging Face Spaces using Gradio.
42
 
43
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference