Skip to content

Commit 3888c08

Browse files
committed
Deprecation notice.
1 parent 8255be7 commit 3888c08

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

+20
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
# Current Readme
2+
3+
NOTE: this code is no longer strictly necessary and is not actively being
4+
maintained. It existed briefly, because agl/ed25519 was deprecated and
5+
contained Edwards-to-Montgomery conversion code that was useful.
6+
7+
Now:
8+
9+
* If you just want ed25519 signatures in Golang, that is [available in the
10+
standard library now](https://golang.org/pkg/crypto/ed25519).
11+
* If you want to manipulate points on the edwards curve and in particular
12+
convert to Montgomery coordinates (the reason for this short lived fork to
13+
exist), there is a maintained library by Filippo and [a function for that](https://pkg.go.dev/filippo.io/edwards25519#Point.BytesMontgomery).
14+
15+
As always with crypto code you should be sure you understand what you are doing
16+
and that you have read the necessary documentation and background material to
17+
make sure you avoid some of the subtle bugs that may exist.
18+
19+
# Previous Readme
20+
121
This repository contains two things:
222

323
1. The Ed25519 code from the Golang standard library.

0 commit comments

Comments
 (0)