Skip to content

Commit

Permalink
fix README, pump to 0.0.3
Browse files Browse the repository at this point in the history
  • Loading branch information
pedia committed Mar 1, 2024
1 parent 7a26a14 commit 11e1773
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 8 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,8 @@
# 0.0.3
fix readme.md

# 0.0.2
add platforms

# 0.0.1
init
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# epub rs
# epubrs(epub reading systems)

[epubrs](https://github.com/pedia/epubrs) is an implement of [epub reading systems](https://www.w3.org/TR/epub-rs/).

Support epub2: 2.0 2.0.1 epub3: 3.0 3.0.1 3.2. Reader is fully tested, and writer is not finished yet.
Support epub2: 2.0 2.0.1 epub3: 3.0 3.0.1 3.2.

Reader is fully tested, and Writer is not finished yet.

## Example with dart:io
```dart
import 'package:archive/archive_io.dart' as epub;
import 'package:epubrs/epubrs_io.dart' as epub;
final book = epub.readFile('test/res/epub3.epub')!;
final book = epub.readFile('test/res/alice.epub')!;
print(book.version); // Version.epub3
print(book.title); // ce's Adventures Under Ground Being a facsimile of the original Ms. book afterwards developed into "Alice's Adventures in Wonderland"
print(book.author); // Lewis Carroll
Expand All @@ -17,9 +19,10 @@ print(book.chapters); // first level chapters

## Example without dart:io
```dart
import 'package:archive/archive.dart' as epub;
import 'package:epubrs/epubrs.dart' as epub;
import 'package:archive/archive_io.dart';
final book = epub.Reader.
open(ZipDecoder().decodeBytes(bytes_or_file_content)).
read();
```
```
15 changes: 13 additions & 2 deletions pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: epubrs
description: EPUB Reading Systems
homepage: https://github.com/pedia/epubrs
version: 0.0.1
version: 0.0.3

environment:
sdk: '>=3.0.0 <4.0.0'
Expand All @@ -15,8 +15,19 @@ dependencies:
quiver: ^3.2.1
xml: ^6.5.0


dev_dependencies:
test: ^1.25.2
lints: ^3.0.0
http: ^1.2.0

platforms:
android:
ios:
linux:
macos:
web:
windows:

topics:
- epub
- book

0 comments on commit 11e1773

Please sign in to comment.