Skip to content

Commit

Permalink
overall micro improvements for the README
Browse files Browse the repository at this point in the history
  • Loading branch information
farooqkz committed Jan 10, 2024
1 parent a1db594 commit 300bb00
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,25 @@ Parsing of Links, Email adresses, simple text formatting (markdown subset), user

The specification can be found in [spec.md](./spec.md).

WASM Demo: <https://deltachat.github.io/message-parser/>
WASM Demo is [here](https://deltachat.github.io/message-parser/)

## Idea behind it
## The idea behind it

Have the same rich message parsing on all platforms.

The basic idea is that core can use this library to convert messages to an AST format,
that can then be displayed by the UIs how they see fit, for desktop it will be converted to react elements.
that can then be displayed by the UIs how they see fit. For [DeltaChat Desktop](https://github.com/deltachat/deltachat-desktop) it will be converted to React elements.

> Desktop already uses this package (minus the markdown, because it does not make sense to only have markdown only on one platform) as wasm module (see `./message_parser_wasm`), later this will probably be integrated into deltachat core.
> Desktop already uses this package (minus the markdown, because it does not make sense to only have markdown only on one platform) as wasm module (see `./message_parser_wasm`), later this will probably be integrated into [the core](https://github.com/deltachat/deltachat-core-rust).
## Coding Principles

- **many** test cases
- aim to be fast - so also benchmarks to make sure the lib stays fast enough
- **Many** test cases
- Aim to be fast - so also benchmarks to make sure the lib stays fast enough

## Recomendations:

If used for message parsing, don't parse messages that are over `10 000` chars in size to ensure performance stays excelent. (the lib could and should support more than that and should aim to be fast enough for it, but on slow devices or transpiled to wasm or asmjs limiting it makes sense to avoid laggy/freezed interface)
If used for message parsing, don't parse messages that are over `10 000` chars in size to ensure performance stays excellent. The lib could and should support more than that and should aim to be fast enough for it, but on slow devices or transpiled to wasm or asmjs limiting it makes sense to avoid laggy/freezed interface

### Benchmarking:

Expand Down

0 comments on commit 300bb00

Please sign in to comment.