Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ on:
branches:
- main

permissions:
contents: read

jobs:
lint-and-test:
name: Lint and Test
Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,12 @@ Available on iOS and Android with the same powerful features and encryption.
- 🔄 **Auto-sync** - Changes to your note automatically update the public version
- ❌ **Instant unpublish** - Remove public access at any time (hard delete)
- 🛡️ **Security hardened** - DOMPurify sanitization, rate limiting, no internal IDs exposed
- 🔍 **SEO optimized** - Server-side rendering for search engine indexing and social previews

> ⚠️ **Important:** Publishing a note bypasses end-to-end encryption. An unencrypted copy is stored on our servers and anyone with the link can view it. Use this feature only for content you intend to share publicly.

> 💡 **Optional:** For improved SEO on public notes, you can deploy the SSR worker. See [`worker/README.md`](./worker/README.md) for setup instructions.

### ⚡ Executable Code Blocks

![Execute Code Demo](https://github.com/typelets/typelets-app/blob/main/assets/execute-code-demo.gif)
Expand Down Expand Up @@ -418,6 +421,9 @@ typelets/
│ │ └── encryption/ # Client-side encryption
│ ├── types/ # TypeScript definitions
│ └── App.tsx # Main App component
├── worker/ # Cloudflare Worker for SSR (optional)
│ ├── src/ # Worker source code
│ └── README.md # SSR setup instructions
├── public/ # Static assets
├── nginx.conf.template # Nginx configuration
├── vite.config.ts # Vite configuration with proxy
Expand Down
Loading
Loading