docs(readme): add badges and social links

Author: dougwithseismic

README.md

@@ -1,84 +1,150 @@
-# Turborepo starter
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![GitHub stars](https://img.shields.io/github/stars/withseismic/cursor-tools?style=social)](https://github.com/withseismic/cursor-tools/stargazers)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.0-blue.svg)](https://www.typescriptlang.org/)
+[![Electron](https://img.shields.io/badge/Electron-28.0-blue.svg)](https://www.electronjs.org/)
+[![React](https://img.shields.io/badge/React-18.0-blue.svg)](https://reactjs.org/)
+[![Discord](https://img.shields.io/badge/Discord-Join%20Chat-7289da.svg)](https://discord.gg/cursor)
 
-This Turborepo starter is maintained by the Turborepo core team.
+[🔗 Reddit Discussion](https://www.reddit.com/r/cursor/comments/1i77m4d/notepads_manager_for_cursor/) | [💬 Discord Community](https://discord.gg/BX25FcS53N)
 
-## Using this example
+# Cursor Tools
 
-Run the following command:
+A powerful desktop application for managing and enhancing your Cursor IDE notepads, built with Electron, React, and TypeScript. (Ish. It's a proof of concept that shows you how to hook into Cursor's workspace / global settings and do some cool stuff.)
 
-```sh
-npx create-turbo@latest
-```
+![Cursor Tools](cursor-tools.png)
 
-## What's inside?
+## Overview
 
-This Turborepo includes the following packages/apps:
+Cursor Tools provides a robust suite of utilities for managing your Cursor IDE notepads, allowing you to backup, sync, and organize your development notes across workspaces. Built with modern technologies and best practices, it offers a seamless integration with your Cursor IDE workflow.
 
-### Apps and Packages
+### Key Features
 
-- `docs`: a [Next.js](https://nextjs.org/) app
-- `web`: another [Next.js](https://nextjs.org/) app
-- `@repo/ui`: a stub React component library shared by both `web` and `docs` applications
-- `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
-- `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo
+#### 1. Notepad Management
 
-Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
+- **Create & Edit**: Create new notepads with rich content and edit existing ones
+- **Organization**: Group related notepads and manage them efficiently
+- **Search & Filter**: Quickly find notepads across all workspaces
+- **Backup & Sync**: Automatically backup your Cursor notepads across workspaces
+- **Import/Export**: Share notepads between workspaces or with team members
 
-### Utilities
+#### 2. Smart Templates
 
-This Turborepo has some additional tools already setup for you:
+Pre-built notepad templates for common development workflows:
 
-- [TypeScript](https://www.typescriptlang.org/) for static type checking
-- [ESLint](https://eslint.org/) for code linting
-- [Prettier](https://prettier.io) for code formatting
+- Git branch and workflow best practices
+- Test-Driven Development (TDD) guides
+- AI-assisted development patterns
+- Documentation templates
+- Code review checklists
+- Performance optimization guides
+- Security best practices
+- Accessibility guidelines
+- Architecture planning templates
 
-### Build
+#### 3. Workspace Integration
 
-To build all apps and packages, run the following command:
+- **Multi-Workspace Support**: Manage notepads across multiple Cursor workspaces
+- **Workspace Migration**: Easily copy notepads between workspaces
+- **Context Awareness**: Notepads maintain references to relevant files and folders
+- **Persistent Storage**: Reliable SQLite-based storage for all your notes
 
-```
-cd my-turborepo
-pnpm build
+#### 4. Advanced Features
+
+- **Version History**: Track changes to your notepads over time
+- **Rich Context**: Link notepads to files, folders, and git commits
+- **Smart References**: Maintain connections to external resources and documentation
+- **Customizable Layout**: Adjust the UI layout to match your workflow
+
+### Installation
+
+```bash
+# Install dependencies
+pnpm install
+
+# Start development
+pnpm dev:electron
+
+# Build for your platform
+pnpm build:win    # Windows
+pnpm build:mac    # macOS
+pnpm build:linux  # Linux
 ```
 
-### Develop
+### Project Structure
 
-To develop all apps and packages, run the following command:
+This project uses [Turborepo](https://turbo.build/repo) and follows modern development practices:
 
 ```
-cd my-turborepo
-pnpm dev
+apps/
+  ├── electron-app/        # Main desktop application
+  │   ├── src/
+  │   │   ├── main/       # Electron main process
+  │   │   ├── renderer/   # React-based UI
+  │   │   └── preload/    # Preload scripts
+  │   └── ...
+packages/
+  ├── eslint-config/      # Shared ESLint configuration
+  └── typescript-config/  # Shared TypeScript configuration
 ```
 
-### Remote Caching
+### Technology Stack
 
-> [!TIP]
-> Vercel Remote Cache is free for all plans. Get started today at [vercel.com](https://vercel.com/signup?/signup?utm_source=remote-cache-sdk&utm_campaign=free_remote_cache).
+- **TypeScript**: For type-safe code
+- **Electron**: Desktop application framework
+- **React**: UI components and state management
+- **SQLite**: Reliable data persistence
+- **Tailwind CSS**: Modern styling
+- **ESLint & Prettier**: Code quality tools
 
-Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.
+### API Documentation
 
-By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup?utm_source=turborepo-examples), then enter the following commands:
+#### Notepad Management
 
-```
-cd my-turborepo
-npx turbo login
-```
+```typescript
+// Create a new notepad
+const notepad = await notepadManager.createNotepad({
+  name: "My Notepad",
+  text: "Initial content"
+});
 
-This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
+// Get all notepads
+const notepads = await notepadManager.getAll();
 
-Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:
+// Get a specific notepad
+const notepad = await notepadManager.getNotepad(id);
 
+// Update notepad content
+await notepad.setText("Updated content");
+
+// Delete a notepad
+await notepadManager.deleteNotepad(id);
 ```
-npx turbo link
+
+#### Workspace Operations
+
+```typescript
+// Get all workspaces
+const workspaces = await workspaceManager.getWorkspaces();
+
+// Get a specific workspace
+const workspace = await workspaceManager.getWorkspace(id);
+
+// Access workspace storage
+await workspace.set("key", value);
+const value = await workspace.get("key");
 ```
 
-## Useful Links
+### Contributing
+
+We welcome contributions! Please follow these steps:
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Submit a pull request
+
+Please ensure your code follows our style guidelines and includes appropriate tests.
 
-Learn more about the power of Turborepo:
+### License
 
-- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
-- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
-- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
-- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
-- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
-- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)
+MIT

apps/electron-app/src/main/features/notepad/notepad-manager.ts

@@ -5,6 +5,7 @@ import { DataValidationError, NotepadError } from '../workspace/errors'
 
 /**
  * Structure for notepad data storage.
+ * Defines the format for persisting notepad data in the workspace.
  */
 interface NotepadData {
   /** Version number of the notepad data format */
@@ -15,6 +16,7 @@ interface NotepadData {
 
 /**
  * Input parameters for creating a new notepad.
+ * Required configuration for notepad creation.
  */
 export interface CreateNotepadInput {
   /** Display name for the new notepad */
@@ -24,9 +26,11 @@ export interface CreateNotepadInput {
 }
 
 /**
- * Validates notepad data structure.
+ * Type guard to validate notepad data structure.
+ * Ensures data loaded from storage matches expected format.
+ *
  * @param {unknown} data - The data to validate
- * @returns {data is NotepadData} Type guard indicating if the data is valid
+ * @returns {boolean} True if data matches NotepadData structure
  */
 function isValidNotepadData(data: unknown): data is NotepadData {
   if (!data || typeof data !== 'object') return false
@@ -42,12 +46,31 @@ function isValidNotepadData(data: unknown): data is NotepadData {
  * Manages notepad instances within a workspace.
  * Handles notepad creation, retrieval, and lifecycle management.
  *
+ * Key responsibilities:
+ * - Creating new notepads with proper initialization
+ * - Managing notepad persistence
+ * - Retrieving existing notepads
+ * - Handling notepad deletion
+ * - Maintaining data consistency
+ *
  * @example
  * ```typescript
  * const manager = new NotepadManager(workspace);
- * const notepad = await manager.createNotepad({ name: 'New Notepad' });
+ *
+ * // Create a new notepad
+ * const notepad = await manager.createNotepad({
+ *   name: 'New Notepad',
+ *   text: 'Initial content'
+ * });
+ *
+ * // Get all notepads
+ * const notepads = await manager.getAll();
+ *
+ * // Get a specific notepad
  * const existingNotepad = await manager.getNotepad('notepad-id');
- * const allNotepads = await manager.getAll();
+ *
+ * // Delete a notepad
+ * await manager.deleteNotepad('notepad-id');
  * ```
  */
 export class NotepadManager {
@@ -62,6 +85,7 @@ export class NotepadManager {
   /**
    * Retrieves the current notepad data from storage.
    * Creates default data structure if none exists.
+   *
    * @private
    * @returns {Promise<NotepadData>} The current notepad data
    * @throws {DataValidationError} If stored data is invalid
@@ -86,6 +110,7 @@ export class NotepadManager {
   /**
    * Creates a default context for new notepads.
    * Initializes all context fields with empty values.
+   *
    * @private
    * @returns {NotepadContext} A new default context object
    */
@@ -134,10 +159,25 @@ export class NotepadManager {
   /**
    * Creates a new notepad with the specified configuration.
    * Initializes the notepad with default context and a single chat tab.
+   *
+   * The creation process:
+   * 1. Validates input parameters
+   * 2. Generates unique IDs for notepad components
+   * 3. Creates initial notepad structure
+   * 4. Persists the notepad to storage
+   *
    * @param {CreateNotepadInput} input - Configuration for the new notepad
    * @returns {Promise<Notepad>} The newly created notepad instance
    * @throws {NotepadError} If notepad creation or save fails
    * @throws {DataValidationError} If input validation fails
+   *
+   * @example
+   * ```typescript
+   * const notepad = await manager.createNotepad({
+   *   name: 'Project Notes',
+   *   text: 'Initial project planning'
+   * });
+   * ```
    */
   async createNotepad(input: CreateNotepadInput): Promise<Notepad> {
     if (!input.name || input.name.trim().length === 0) {
@@ -192,10 +232,20 @@ export class NotepadManager {
 
   /**
    * Retrieves a notepad by its ID.
+   * Returns null if no notepad exists with the given ID.
+   *
    * @param {string} id - The unique identifier of the notepad
    * @returns {Promise<Notepad | null>} The notepad instance if found, null otherwise
    * @throws {NotepadError} If notepad retrieval fails
    * @throws {DataValidationError} If stored notepad data is invalid
+   *
+   * @example
+   * ```typescript
+   * const notepad = await manager.getNotepad('notepad-123');
+   * if (notepad) {
+   *   await notepad.setText('Updated content');
+   * }
+   * ```
    */
   async getNotepad(id: string): Promise<Notepad | null> {
     if (!id || typeof id !== 'string') {
@@ -218,9 +268,19 @@ export class NotepadManager {
 
   /**
    * Retrieves all notepads in the workspace.
+   * Loads and validates notepad data from storage.
+   *
    * @returns {Promise<Notepad[]>} Array of all notepad instances
    * @throws {NotepadError} If notepad retrieval fails
    * @throws {DataValidationError} If stored notepad data is invalid
+   *
+   * @example
+   * ```typescript
+   * const notepads = await manager.getAll();
+   * for (const notepad of notepads) {
+   *   console.log(notepad.data.name);
+   * }
+   * ```
    */
   async getAll(): Promise<Notepad[]> {
     try {
@@ -236,10 +296,20 @@ export class NotepadManager {
 
   /**
    * Deletes a notepad by its ID.
+   * Removes the notepad from storage if it exists.
+   *
    * @param {string} id - The unique identifier of the notepad to delete
    * @returns {Promise<boolean>} True if the notepad was found and deleted, false otherwise
    * @throws {NotepadError} If notepad deletion fails
    * @throws {DataValidationError} If notepad ID is invalid
+   *
+   * @example
+   * ```typescript
+   * const wasDeleted = await manager.deleteNotepad('notepad-123');
+   * if (wasDeleted) {
+   *   console.log('Notepad successfully deleted');
+   * }
+   * ```
    */
   async deleteNotepad(id: string): Promise<boolean> {
     if (!id || typeof id !== 'string') {