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 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
|
||||
|
||||
@@ -21,7 +22,7 @@ go run .
|
||||
|
||||
Nebula converts HTML prototypes to Go `templ` templates with HTMX for server-driven UI:
|
||||
|
||||
```
|
||||
```text
|
||||
Browser Go Server
|
||||
------- ---------
|
||||
[Web Awesome UI] <-- HTMX --> [Templ Renderer]
|
||||
@@ -40,7 +41,7 @@ Browser Go Server
|
||||
|
||||
## Directory Structure
|
||||
|
||||
```
|
||||
```text
|
||||
nebula/
|
||||
├── views/ # Page templates
|
||||
├── layouts/ # Base layouts
|
||||
@@ -60,19 +61,22 @@ nebula/
|
||||
## Pages
|
||||
|
||||
### Auth Pages (Popup/Webview Optimized)
|
||||
|
||||
- **Welcome**: 3-step onboarding stepper
|
||||
- **Login**: WebAuthn sign-in with passkey/security key/QR
|
||||
- **Register**: Device detection + registration wizard
|
||||
- **Authorize**: OAuth consent for connect/sign/transaction
|
||||
|
||||
### Dashboard Pages
|
||||
|
||||
- **Accounts**: Token balances, transactions, drawers
|
||||
- **NFTs**: Gallery with collections, filters, actions
|
||||
- **Service**: Connected service detail with permissions
|
||||
|
||||
## 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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user