Skip to content

Commit

Permalink
update encoder readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AntonKueltz committed Jan 1, 2025
1 parent 2bb9230 commit 2fa1177
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions fastecdsa/encoding/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,10 @@ with keys and signatures.
## Keys

Key encoders should inherit from the `fastecdsa.encoding.KeyEncoder` class. They
should implement all of `KeyEncoder`'s abstract methods as static methods. If an
encoder only operates on public or private keys then the non-applicable methods
should raise `NotImplementedError`s.
should implement all of `KeyEncoder`'s abstract methods. If an encoder only operates
on public or private keys then the non-applicable methods should raise `NotImplementedError`s.

## Signatures

Signature encoders should inherit from the `fastecdsa.encoding.SigEncoder` class.
They should implement all of `SigEncoder`'s abstract methods as static methods.
They should implement all of `SigEncoder`'s abstract methods.

0 comments on commit 2fa1177

Please sign in to comment.