C.A.N. for Developers

NPM Package

The official TypeScript-first NPM package for building reading and note-taking applications with The C.A.N. System.

npm install curtiss-annotation-nomenclature

What’s Included

• All 100 CAN Codes and 3 CAN Emphasizers with descriptions
• Type-safe enums and TypeScript types
• Validation functions for the CAN Codes and CAN Emphasizers
• Formatting utilities for text and UI rendering
• Immutable data structures frozen to ensure that the package follows the precise CAN Specification

Use Cases

• Building reading/note-taking applications
• Research paper analysis tools
• Study and exam preparation apps
• Browser extensions for annotation
• Mobile reading applications

Learn More

NPM Documentation - Complete API reference, usage examples, and TypeScript types

Official C.A.N. Guide - The authoritative source for the C.A.N. system specification

Contributing to the Package

The NPM package is open source (MIT License). Various contributions are welcome:

• Package improvements: TypeScript types, utilities, documentation, tests
• Bug fixes: Issues with the implementation
• New features: Developer experience enhancements

Important: All 100 CAN Codes are defined by the Official C.A.N. Guide. Changes to the CAN Codes should be proposed through the contact form, or The Official CAN Discussions board, but not the NPM package repository.

Get Involved:

• Report a Bug or Request a Feature - Open an issue in the NPM package repository
• View Open Issues - See what’s being discussed
• NPM Package Repository - Browse the source code, submit issues, and get your pull request merged