notedeck

One damus client to rule them all
git clone git://jb55.com/notedeck
Log | Files | Refs | README | LICENSE

README.md (1529B)


      1 # Notedeck Chrome
      2 
      3 Notedeck Chrome is the UI framework and container for the Notedeck Nostr browser. It manages multiple applications within a single cohesive interface, providing a consistent navigation experience through a persistent sidebar.
      4 
      5 ## Overview
      6 
      7 Notedeck Chrome acts as the container for various applications within the Notedeck ecosystem, primarily:
      8 
      9 - **Columns** - The main Nostr columns interface for viewing timelines and interactions
     10 - **Dave** - An ai assistant
     11 - **Other** - Anything else *tbd*
     12 
     13 The Chrome component provides:
     14 
     15 - A consistent, unified sidebar for navigation between applications
     16 - Theme management (light/dark mode support)
     17 - Profile picture and account management
     18 - Settings access
     19 - Wallet integration
     20 
     21 ## Features
     22 
     23 - **Application Switching**: Switch between Damus columns view and Dave seamlessly
     24 - **Theme Support**: Toggle between light and dark modes
     25 - **Profile Management**: Quick access to account settings
     26 - **Responsive Design**: Compatible with desktop and mobile interfaces
     27 - **Android Support**: Native support for Android devices
     28 
     29 Future:
     30 
     31 - **Signer**: Apps will be sandboxed from the users key
     32 
     33 ## Development Status
     34 
     35 Notedeck is currently in **ALPHA**. Expect bugs and please report any issues you encounter.
     36 
     37 ## Building from Source
     38 
     39 For build instructions, see the [DEVELOPER.md](DEVELOPER.md) file.
     40 
     41 ## License
     42 
     43 Licensed under GPLv3 - see the [Cargo.toml](Cargo.toml) file for details.
     44 
     45 ## Authors
     46 
     47 - William Casarin <jb55@jb55.com>
     48 - kernelkind <kernelkind@gmail.com>