ChaoticEconomist commited on
Commit
c6030ed
·
verified ·
1 Parent(s): fe2220b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +78 -0
README.md CHANGED
@@ -10,3 +10,81 @@ pinned: false
10
  ---
11
 
12
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
10
  ---
11
 
12
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
13
+
14
+
15
+
16
+ # 🧱 Blocksmith AI (Powered by Grok)
17
+
18
+ Blocksmith is an AI-powered text structuring and editing tool that transforms raw input into modular “blocks” — enabling precise editing, rewriting, and full-document refinement.
19
+
20
+ ---
21
+
22
+ ## ✨ Features
23
+
24
+ ### 🧩 Block-Based Editing
25
+ - Paste any text
26
+ - Automatically split into structured blocks
27
+ - Select and edit individual lines easily
28
+
29
+ ### ✨ AI Rewrite (Block-Level)
30
+ - Improve clarity and professionalism of a selected block
31
+ - Works like a “smart editor” for each line
32
+
33
+ ### 🚀 AI Rewrite (Full Document)
34
+ - Rewrites the entire text
35
+ - Outputs result separately (preserves original blocks)
36
+ - Ideal for polishing final drafts
37
+
38
+ ### 🛠 Manual Control
39
+ - Edit any block manually
40
+ - Update and refine iteratively
41
+
42
+ ---
43
+
44
+ ## 🧠 Why Blocksmith?
45
+
46
+ Most AI tools treat text as one big blob.
47
+
48
+ **Blocksmith introduces granular AI control over text structure.**
49
+
50
+ This allows:
51
+ - Line-by-line refinement
52
+ - Selective rewriting
53
+ - Better reasoning workflows
54
+
55
+ ---
56
+
57
+ ## 🖥️ How to Use
58
+
59
+ 1. Paste your text into the input box
60
+ 2. Click **Create Blocks**
61
+ 3. Select a block from the dropdown
62
+ 4. Choose an action:
63
+ - **Update** → manually edit
64
+ - **✨ Rewrite (AI)** → improve selected block
65
+ - **🚀 Rewrite All (AI)** → rewrite entire text
66
+
67
+ 5. View the rewritten output in the **Rewritten Full Text** section
68
+
69
+ ---
70
+ ## ⚙️ Tech Stack
71
+ - Frontend/UI: Gradio
72
+ - LLM Backend: Grok (xAI)
73
+ - Hosting: Hugging Face Spaces
74
+
75
+ ## 🚧 Known Limitations
76
+ - Depends on external API (latency may vary)
77
+ - Large inputs may be truncated due to token limits
78
+ - Block splitting is line-based (not semantic… yet)
79
+
80
+ ## 🔮 Future Improvements
81
+ - Multi-agent rewriting (per block)
82
+ - Notion-style inline editing
83
+ - Diff view (original vs rewritten)
84
+ - Export to Markdown / Docs
85
+ - Style modes (formal, concise, creative)
86
+
87
+
88
+ ## 👨‍💻 Author
89
+ Anuraag Rath
90
+