Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add docs to readme #26

Merged
merged 3 commits into from
Jan 6, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,16 @@ puts Secp256k1::Ethereum.address_from_public_key uncompressed
# > "0x2Ef1f605AF5d03874eE88773f41c1382ac71C239"
```

# documentation

the full library documentation can be found here: [q9f.github.io/secp256k1.cr](https://q9f.github.io/secp256k1.cr/)

generate a local copy with:

```
crystal docs
```

# testing

the library is entirely specified through tests in `./spec`; run:
Expand Down
10 changes: 5 additions & 5 deletions docs/Secp256k1.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,35 +141,35 @@ <h2>
</h2>


<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/bitcoin.cr#L16" target="_blank">
<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/bitcoin.cr#L16" target="_blank">
bitcoin.cr
</a>

<br/>


<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/constants.cr#L19" target="_blank">
<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/constants.cr#L19" target="_blank">
constants.cr
</a>

<br/>


<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/structs.cr#L16" target="_blank">
<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/structs.cr#L16" target="_blank">
structs.cr
</a>

<br/>


<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/version.cr#L16" target="_blank">
<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/version.cr#L16" target="_blank">
version.cr
</a>

<br/>


<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/secp256k1.cr#L26" target="_blank">
<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/secp256k1.cr#L26" target="_blank">
secp256k1.cr
</a>

Expand Down
26 changes: 13 additions & 13 deletions docs/Secp256k1/Bitcoin.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ <h2>
</h2>


<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/bitcoin.cr#L16" target="_blank">
<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/bitcoin.cr#L16" target="_blank">
bitcoin.cr
</a>

Expand Down Expand Up @@ -288,7 +288,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/bitcoin.cr#L231" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/bitcoin.cr#L231" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -310,7 +310,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/bitcoin.cr#L163" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/bitcoin.cr#L163" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -331,7 +331,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/bitcoin.cr#L195" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/bitcoin.cr#L195" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -352,7 +352,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/bitcoin.cr#L205" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/bitcoin.cr#L205" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -373,7 +373,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/bitcoin.cr#L111" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/bitcoin.cr#L111" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -394,7 +394,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/bitcoin.cr#L18" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/bitcoin.cr#L18" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -415,7 +415,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/bitcoin.cr#L47" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/bitcoin.cr#L47" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -436,7 +436,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/bitcoin.cr#L80" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/bitcoin.cr#L80" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -457,7 +457,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/bitcoin.cr#L96" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/bitcoin.cr#L96" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -478,7 +478,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/bitcoin.cr#L75" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/bitcoin.cr#L75" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -499,7 +499,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/bitcoin.cr#L53" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/bitcoin.cr#L53" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -520,7 +520,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/bitcoin.cr#L126" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/bitcoin.cr#L126" target="_blank">View source</a>]

</div>
</div>
Expand Down
10 changes: 5 additions & 5 deletions docs/Secp256k1/Core.html
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ <h2>
</h2>


<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/core.cr#L17" target="_blank">
<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/core.cr#L17" target="_blank">
core.cr
</a>

Expand Down Expand Up @@ -235,7 +235,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/core.cr#L43" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/core.cr#L43" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -259,7 +259,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/core.cr#L59" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/core.cr#L59" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -280,7 +280,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/core.cr#L19" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/core.cr#L19" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -303,7 +303,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/core.cr#L74" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/core.cr#L74" target="_blank">View source</a>]

</div>
</div>
Expand Down
12 changes: 6 additions & 6 deletions docs/Secp256k1/ECDSA_Signature.html
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ <h2>
</h2>


<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/structs.cr#L30" target="_blank">
<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/structs.cr#L30" target="_blank">
structs.cr
</a>

Expand Down Expand Up @@ -264,7 +264,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/structs.cr#L37" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/structs.cr#L37" target="_blank">View source</a>]

</div>
</div>
Expand Down Expand Up @@ -299,7 +299,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/structs.cr#L32" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/structs.cr#L32" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -320,7 +320,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/structs.cr#L32" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/structs.cr#L32" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -341,7 +341,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/structs.cr#L35" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/structs.cr#L35" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -362,7 +362,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/structs.cr#L35" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/structs.cr#L35" target="_blank">View source</a>]

</div>
</div>
Expand Down
12 changes: 6 additions & 6 deletions docs/Secp256k1/EC_Point.html
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ <h2>
</h2>


<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/structs.cr#L18" target="_blank">
<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/structs.cr#L18" target="_blank">
structs.cr
</a>

Expand Down Expand Up @@ -264,7 +264,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/structs.cr#L25" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/structs.cr#L25" target="_blank">View source</a>]

</div>
</div>
Expand Down Expand Up @@ -299,7 +299,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/structs.cr#L20" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/structs.cr#L20" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -320,7 +320,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/structs.cr#L20" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/structs.cr#L20" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -341,7 +341,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/structs.cr#L23" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/structs.cr#L23" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -362,7 +362,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/structs.cr#L23" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/structs.cr#L23" target="_blank">View source</a>]

</div>
</div>
Expand Down
10 changes: 5 additions & 5 deletions docs/Secp256k1/Ethereum.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ <h2>
</h2>


<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/ethereum.cr#L16" target="_blank">
<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/ethereum.cr#L16" target="_blank">
ethereum.cr
</a>

Expand Down Expand Up @@ -232,7 +232,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/ethereum.cr#L18" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/ethereum.cr#L18" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -253,7 +253,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/ethereum.cr#L75" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/ethereum.cr#L75" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -274,7 +274,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/ethereum.cr#L53" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/ethereum.cr#L53" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -295,7 +295,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/q9f/secp256k1.cr/blob/f44b5dce027b43592aa6dd7ab8d3cea3319a517a/src/ethereum.cr#L68" target="_blank">View source</a>]
[<a href="https://github.com/q9f/secp256k1.cr/blob/90277a931d1866de696bde9fe0ca31871b26b7c4/src/ethereum.cr#L68" target="_blank">View source</a>]

</div>
</div>
Expand Down
Loading