@likecoin/epubcheck-ts 0.1.0 → 0.2.0

package/README.md

@@ -6,14 +6,20 @@ A TypeScript port of [EPUBCheck](https://github.com/w3c/epubcheck) - the officia
 [![npm](https://img.shields.io/npm/v/%40likecoin%2Fepubcheck-ts)](https://www.npmjs.com/package/@likecoin/epubcheck-ts)
 [![License](https://img.shields.io/npm/l/%40likecoin%2Fepubcheck-ts)](./LICENSE)
 
+> **Note**: This library is primarily developed for internal use at [3ook.com](https://3ook.com/about) and is built with AI-assisted development. While it has comprehensive test coverage (208 tests) and ~65% feature parity with Java EPUBCheck, it may not be suitable for mission-critical production workloads. For production environments requiring full EPUB validation, consider using the official [Java EPUBCheck](https://github.com/w3c/epubcheck). Contributions and feedback are welcome!
+
 ## Features
 
 - **Cross-platform**: Works in Node.js (18+) and modern browsers
-- **Partial EPUB validation**: Currently ~35% of EPUBCheck feature parity
+- **Partial EPUB validation**: Currently ~65% of EPUBCheck feature parity
 - **Zero native dependencies**: Pure JavaScript/WebAssembly, no compilation required
 - **TypeScript first**: Full type definitions included
 - **Tree-shakable**: ESM with proper exports for optimal bundling
 
+## Try it Online
+
+Try the live demo at **[likecoin.github.io/epubcheck-ts](https://likecoin.github.io/epubcheck-ts/)** - validate your EPUB files directly in the browser without uploading to any server.
+
 ## Installation
 
 ```bash
@@ -214,19 +220,20 @@ This library is a TypeScript port of the Java-based [EPUBCheck](https://github.c
 
 | Component | Status | Completeness | Notes |
 |-----------|--------|--------------|-------|
-| OCF Container | 🟡 Partial | ~40% | ZIP structure, mimetype, container.xml |
-| Package Document (OPF) | 🟡 Partial | ~40% | Metadata, manifest, spine, fallback chains |
-| Content Documents | 🟡 Partial | ~25% | XML well-formedness, XHTML structure |
-| Navigation Document | 🟡 Partial | ~30% | Nav structure, NCX validation |
+| OCF Container | 🟡 Partial | ~70% | ZIP structure, mimetype (uncompressed check), container.xml |
+| Package Document (OPF) | 🟡 Partial | ~70% | Metadata, manifest, spine, collections, version/date validation |
+| Content Documents | 🟡 Partial | ~70% | XHTML structure, script/MathML/SVG detection, link validation |
+| Navigation Document | 🟡 Partial | ~40% | Nav structure, NCX validation, remote link validation |
 | Schema Validation | 🟡 Partial | ~70% | RelaxNG, XSD, Schematron working |
-| CSS | 🔴 Basic | ~5% | Parser available, validation minimal |
+| CSS | 🟡 Partial | ~50% | @font-face, @import, media overlay classes, position warnings |
+| Cross-reference Validation | 🟡 Partial | ~75% | Reference tracking, fragment validation, undeclared resources |
+| Accessibility Checks | 🟡 Partial | ~75% | Empty links, image alt, SVG titles, MathML alttext |
 | Media Overlays | ❌ Not Started | 0% | Planned |
-| Cross-reference Validation | 🔴 Basic | ~15% | Basic reference tracking |
-| Accessibility Checks | ❌ Not Started | 0% | Alt text, etc. |
+| Media Validation | ❌ Not Started | 0% | Planned |
 
 Legend: 🟢 Complete | 🟡 Partial | 🔴 Basic | ❌ Not Started
 
-**Overall Progress: ~35% of Java EPUBCheck features**
+**Overall Progress: ~65% of Java EPUBCheck features**
 
 See [PROJECT_STATUS.md](./PROJECT_STATUS.md) for detailed comparison.
 
@@ -306,7 +313,7 @@ Legend: ✅ Implemented
 | Aspect | epubcheck-ts | EPUBCheck (Java) |
 |--------|--------------|------------------|
 | Runtime | Node.js / Browser | JVM |
-| Feature Parity | ~35% | 100% |
+| Feature Parity | ~65% | 100% |
 | Bundle Size | ~55KB JS + ~1.5MB WASM | ~15MB |
 | Installation | `npm install` | Download JAR |
 | Integration | Native JS/TS | CLI or Java API |
@@ -332,6 +339,10 @@ This is an independent TypeScript implementation inspired by the Java-based [EPU
 - [DAISY Consortium](https://daisy.org/) - Maintainers of EPUBCheck
 - [libxml2-wasm](https://github.com/jameslan/libxml2-wasm) - WebAssembly XML processing
 
+## Built by 3ook.com
+
+This project is built and maintained by the [3ook.com](https://3ook.com/about) team. 3ook is a Web3 eBook platform where authors can publish EPUB ebooks and readers can collect them as digital assets. If you're an author looking to publish your ebook, check out [3ook.com](https://3ook.com/about).
+
 ## Related Projects
 
 - [EPUBCheck](https://github.com/w3c/epubcheck) - Official Java validator