Skip to content

Commit 285750e

Browse files
improved clarity in README
1 parent 7095122 commit 285750e

1 file changed

Lines changed: 35 additions & 1 deletion

File tree

README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,9 +181,44 @@ hp autocomplete install
181181

182182
# Follow the instructions for your shell
183183
```
184+
## 🧠 Understanding State in Hackpack
185+
186+
Hackpack keeps track of your setup progress and project preferences using a persistent state file. This is especially useful when:
187+
188+
- You stop midway during setup (e.g., terminal closes unexpectedly)
189+
- You want to resume an incomplete setup
190+
- You're managing **multiple projects** at the same time
191+
192+
The state is stored in a hidden `.hackpack-state.json` file (in your project folder or home directory), and it keeps track of configuration choices and setup progress.
193+
194+
### ✅ What Does Hackpack Save in State?
195+
196+
- 📝 **Project Name**
197+
- ⚙️ **Framework** (React, Next.js, Angular, etc.)
198+
- 🎨 **Styling & UI libraries** (shadcn/ui, DaisyUI, etc.)
199+
- 🗄️ **Database** (MongoDB, PostgreSQL)
200+
- 🔐 **Authentication** (Clerk, Supabase, etc.)
201+
- 🧱 **Setup Step Tracking** (for resume support)
202+
203+
Each project you create gets its own state and can be resumed or configured independently!
204+
205+
### 🔧 Commands That Use State
206+
207+
| Command | Purpose |
208+
|------------------------|---------|
209+
| `hp` | Start a new project with a clean state |
210+
| `hp run` | Builds or continues setup for the active project |
211+
| `hp resume` | Resume the last project setup from where you left off |
212+
| `hp select <project>` | Switch between saved projects before running/resuming |
213+
| `hp state` | View all saved project states and active project |
214+
| `hp reset` | Completely clears all saved state (fresh start) |
215+
216+
---
217+
184218
185219
---
186220
221+
187222
## 🎨 Supported Stacks
188223
189224
### Frontend Frameworks
@@ -263,4 +298,3 @@ Made with ❤️ by TeamHackpack ( Varun & Yash ) — because setup time is codi
263298
</p>
264299
265300
</div>
266-

0 commit comments

Comments
 (0)