Skip to content

Commit e320e0e

Browse files
author
danil-nizamov
committed
updated readme
1 parent a4850c4 commit e320e0e

File tree

1 file changed

+6
-17
lines changed

1 file changed

+6
-17
lines changed

README.md

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,28 @@ This directory contains reusable components for creating embedded applications t
44

55
## Components
66

7-
### 1. `bespoke.css`
7+
### 1. `client/bespoke.css`
88
The core CSS framework providing:
99
- Consistent design tokens (colors, spacing, typography)
1010
- Light and dark theme support
1111
- Reusable component styles (buttons, forms, modals, cards)
1212
- Responsive design utilities
1313

14-
### 2. `index.html`
14+
### 2. `client/index.html`
1515
A base HTML template that includes:
1616
- Navigation header with app name and help button
1717
- Main layout structure (sidebar + content area)
1818
- Help modal integration
1919
- Proper CSS and JavaScript loading
2020

21-
### 3. `help-modal.js`
21+
### 3. `client/help-modal.js`
2222
A dependency-free JavaScript module for the help modal system:
2323
- Consistent modal behavior across all apps
2424
- Keyboard navigation (ESC to close)
2525
- Focus management
2626
- Custom event system
2727

28-
### 4. `help-content-template.html`
28+
### 4. `client/help-content-template.html`
2929
A template for creating consistent help content:
3030
- Table of contents navigation
3131
- Standardized section structure
@@ -45,7 +45,7 @@ A template for creating consistent help content:
4545
- `<!-- APP_SPECIFIC_CSS -->` - Links to your app-specific CSS files
4646
- `<!-- APP_SPECIFIC_SCRIPTS -->` - Links to your app-specific JavaScript files
4747

48-
3. **Implement your application logic**. You can use Cursor or other agents for it. There is a file called `context.txt` that contains context LLM can use.
48+
3. **Implement your application logic**. You can use Cursor or other agents for it. There is a file called `AGENTS.md` that contains context LLM can use.
4949
4. **Customise your help content** using the help content template
5050

5151
### Customizing Help Content
@@ -115,7 +115,7 @@ The server will start on `http://localhost:3000` by default.
115115

116116
### WebSocket Messaging API
117117

118-
The server provides a `POST /message` endpoint that allows you to send real-time messages to connected clients. This can be used to signal changes in the client during events like "Run" or "Submit". When a message is sent, the preview window with the application open will display an alert with the message.
118+
The server provides a `POST /message` endpoint that allows you to send real-time messages to connected clients. This can be used to signal changes in the client during events like "Run" or "Submit". When a message is sent, the preview window with the application open will display an alert with the message.
119119

120120
It uses the `ws` package, so if you want to use it, install the packages (but this is optional).
121121

@@ -138,14 +138,3 @@ curl -X POST http://localhost:3000/message \
138138
-H "Content-Type: application/json" \
139139
-d '{"message": "Hello from the server!"}'
140140
```
141-
142-
## File Structure
143-
144-
```
145-
generalised/
146-
├── bespoke.css # Core CSS framework
147-
├── index.html # Base HTML template
148-
├── help-modal.js # Help modal JavaScript
149-
├── help-content-template.html # Help content template
150-
└── README.md # This file
151-
```

0 commit comments

Comments
 (0)