docs(readme): improve markdown formatting and add line breaks for readability
This commit is contained in:
12
README.md
12
README.md
@@ -1,6 +1,7 @@
|
|||||||
# Nebula
|
# Nebula
|
||||||
|
|
||||||
Nebula is the Go Templ implementation of the Sonr WebAwesome Web Component Framework, providing server-driven UI with HTMX integration.
|
Nebula is the Go Templ implementation of the Sonr WebAwesome Web Component Framework,
|
||||||
|
providing server-driven UI with HTMX integration.
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
@@ -21,7 +22,7 @@ go run .
|
|||||||
|
|
||||||
Nebula converts HTML prototypes to Go `templ` templates with HTMX for server-driven UI:
|
Nebula converts HTML prototypes to Go `templ` templates with HTMX for server-driven UI:
|
||||||
|
|
||||||
```
|
```text
|
||||||
Browser Go Server
|
Browser Go Server
|
||||||
------- ---------
|
------- ---------
|
||||||
[Web Awesome UI] <-- HTMX --> [Templ Renderer]
|
[Web Awesome UI] <-- HTMX --> [Templ Renderer]
|
||||||
@@ -40,7 +41,7 @@ Browser Go Server
|
|||||||
|
|
||||||
## Directory Structure
|
## Directory Structure
|
||||||
|
|
||||||
```
|
```text
|
||||||
nebula/
|
nebula/
|
||||||
├── views/ # Page templates
|
├── views/ # Page templates
|
||||||
├── layouts/ # Base layouts
|
├── layouts/ # Base layouts
|
||||||
@@ -60,19 +61,22 @@ nebula/
|
|||||||
## Pages
|
## Pages
|
||||||
|
|
||||||
### Auth Pages (Popup/Webview Optimized)
|
### Auth Pages (Popup/Webview Optimized)
|
||||||
|
|
||||||
- **Welcome**: 3-step onboarding stepper
|
- **Welcome**: 3-step onboarding stepper
|
||||||
- **Login**: WebAuthn sign-in with passkey/security key/QR
|
- **Login**: WebAuthn sign-in with passkey/security key/QR
|
||||||
- **Register**: Device detection + registration wizard
|
- **Register**: Device detection + registration wizard
|
||||||
- **Authorize**: OAuth consent for connect/sign/transaction
|
- **Authorize**: OAuth consent for connect/sign/transaction
|
||||||
|
|
||||||
### Dashboard Pages
|
### Dashboard Pages
|
||||||
|
|
||||||
- **Accounts**: Token balances, transactions, drawers
|
- **Accounts**: Token balances, transactions, drawers
|
||||||
- **NFTs**: Gallery with collections, filters, actions
|
- **NFTs**: Gallery with collections, filters, actions
|
||||||
- **Service**: Connected service detail with permissions
|
- **Service**: Connected service detail with permissions
|
||||||
|
|
||||||
## Migration
|
## Migration
|
||||||
|
|
||||||
See [MIGRATION.md](./MIGRATION.md) for detailed migration steps, component patterns, and HTMX integration examples.
|
See [MIGRATION.md](./MIGRATION.md) for detailed migration steps, component patterns,
|
||||||
|
and HTMX integration examples.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user