Skip to content

Commit

Permalink
docs: improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
r3pwn committed Sep 5, 2023
1 parent 616725d commit 9b0b451
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,26 @@
A WebUSB implementation of the Odin protocol, used for interfacing with Samsung devices in "Download mode"

## Status
### Working
### [Known issues](https://github.com/r3pwn/libmjolnir/wiki/Known-issues)

### Working features
- PIT parsing
- Odin handshake
- Download PIT
- Device Reboot
- Erase userdata
- Flash partition

### Planned
### Planned features
- Upload PIT

## Building
`yarn # only needs to be run once, to install dependencies`
`yarn build`

## Building the example project
`cd example`
`yarn dev --host`

## Unit tests
`yarn test`

0 comments on commit 9b0b451

Please sign in to comment.