@embedder/embedder 2.0.32 → 2.0.34

package/README.md

@@ -1,84 +1,55 @@
 # Embedder
 
-**Coding Agent for Embedded Software**
+![](https://img.shields.io/badge/Node.js-18%2B-brightgreen?style=flat-square) [![npm]](https://www.npmjs.com/package/@embedder/embedder)
 
-Embedder is an AI-powered CLI agent specializing in embedded systems development. It can write and test firmware on real hardware, combining documentation indexing, hardware-aware code generation, and autonomous debugging to eliminate the tedious parts of firmware development.
+[npm]: https://img.shields.io/npm/v/@embedder/embedder.svg?style=flat-square
 
-🌐 [embedder.dev](https://embedder.dev) | Backed by Y Combinator
+Embedder is an AI coding tool that lives in your terminal, specializing in embedded software development. It understands your hardware, indexes datasheets and reference manuals, and helps you write and test firmware faster by executing routine tasks, debugging on real hardware, and handling complex peripheral configurations.
 
-## Installation
+**Learn more in the [official documentation](https://docs.embedder.dev)**.
 
-```bash
-npm install -g @embedder/embedder
-```
+## Get started
 
-## Quick Start
+1. Install Embedder:
 
-```bash
-embedder
+```sh
+npm install -g @embedder/embedder
 ```
 
-Embedder will launch an interactive terminal interface where you can start building firmware, analyzing datasheets, or debugging hardware issues.
+2. Navigate to your project directory and run `embedder`.
 
 ## What Makes Embedder Different
 
-Embedder isn't just another coding assistant—it's built specifically for embedded systems:
+Embedder is built specifically for embedded systems:
 
-- **Hardware-Aware**: Understands microcontroller peripherals, memory constraints, and real-time requirements
+- **Hardware-Aware**: Understands microcontroller peripherals (GPIO, SPI, I²C, UART, ADC, DMA, timers, interrupts), memory constraints, and real-time requirements
 - **Documentation Intelligence**: Indexes datasheets, reference manuals, and schematics to generate code based on your actual hardware specs
 - **Real Hardware Integration**: Connects with serial ports, debuggers, logic analyzers, and oscilloscopes to validate and debug on physical devices
-- **Embedded Expertise**: Deep knowledge of GPIO, SPI, I²C, UART, ADC, DMA, timers, interrupts, and RTOS systems
-
-## Core Capabilities
-
-### Analysis & Planning
-- Requirements analysis and task breakdown
-- System architecture design considering microcontroller peripherals
-- Dependency mapping and integration planning
-- Risk assessment for hardware constraints, timing, and memory
+- **Embedded Expertise**: Deep knowledge of RTOS systems, low-level driver development, and MISRA-C/C++ compliance
 
-### Hardware Interface Expertise
-- Peripheral programming (GPIO, SPI, I²C, UART, ADC, DMA, Timers, Interrupts)
-- Memory management and optimization (RAM/Flash)
-- Real-time systems and RTOS integration
-- Low-level driver development and HAL layers
-
-### Code Quality & Standards
-- MISRA-C/C++ compliance
-- Performance, memory, and power optimization
-- Static analysis and code review
-- Datasheet analysis and hardware specification verification
-
-### Hardware Validation
-- Serial port monitoring and debugging
-- GDB debugger integration
-- Logic analyzer and oscilloscope integration
-- Autonomous issue detection and fixing
+## Supported Platforms
 
-## How It Works
+Works with any embedded platform including ESP32, STM32, nRF, Raspberry Pi Pico, Arduino, and more. Compatible with all major toolchains including GCC, IAR, Keil, and vendor-specific compilers.
 
-1. **Drop in Documentation**: Add your datasheets, reference manuals, schematics, and company knowledge. Advanced RAG extracts register maps, timing constraints, and peripheral configurations.
+## Connect on Discord
 
-2. **Write Embedded Code**: Generate code for any platform (ESP32, STM32, nRF, etc.) based on your actual hardware specs, not generic examples. Works with any toolchain.
+Join the [Embedder Discord](https://discord.com/invite/NMT5ndEyxk) to connect with other embedded developers. Get help, share feedback, and discuss your projects with the community.
 
-3. **Validate on Hardware**: Connect directly with serial ports, debuggers, and test equipment. Embedder reads output, steps through code, and autonomously fixes issues.
+## Data collection, usage, and retention
 
-4. **Local & Secure**: State-of-the-art indexing for large codebase understanding. Keep your proprietary code secure with local processing.
+When you use Embedder, we collect feedback, which includes usage data.
 
-## Supported Platforms
+### How we use your data
 
-Works with any embedded platform including:
-- ESP32, ESP8266
-- STM32 family
-- Nordic nRF series
-- Raspberry Pi Pico
-- Arduino
-- And many more...
+We use your data to:
+- Provide and maintain our services
+- Improve our services and develop new features
+- Provide customer support and technical assistance
 
-## Learn More
+All codebase indexing happens locally on your machine. For cloud features, we offer enterprise agreements with strict data isolation and compliance with ITAR, ISO 27001, and other standards.
 
-Visit [embedder.dev](https://embedder.dev) for documentation, examples, and tutorials.
+### Privacy safeguards
 
----
+We have implemented several safeguards to protect your data, including limited retention periods for sensitive information, restricted access to user session data, and clear policies against using feedback for model training without consent.
 
-Used by 1000+ engineers at companies like Meta, Tesla, Google, NVIDIA, OpenAI, Medtronic, Arm, and Apple.
+For full details, please review our [Terms of Service](https://embedder.dev/terms-of-service) and [Privacy Policy](https://embedder.dev/privacy-policy).