Update README.md with some of the plan

This commit is contained in:
idk
2021-04-22 23:47:04 -04:00
parent 1ea426da9c
commit 7893694c91

View File

@ -4,10 +4,34 @@ A pure Go implementation of the I2P router.
## Status
go-i2p is in early development.
go-i2p was in early development. Now it's being restructured in some
fundamental ways, so it's even less done than before(on this branch, for now)
but when this restructuring is complete, it will be a fully-fledged I2P router
and library for writing, embedding, and possiblly extending I2P routers in Go
applications.
The go module is declared as: github.com/go-i2p/go-i2p, in order to clone
anonymously you may use `torsocks` with `go get`(YMMV) or you may clone
it from git.idk.i2p using:
#Set your $GOPATH, if it isn't set already then GOPATH=$HOME/go
$GOPATH/go/src/i2pgit.org/idk/
git clone git@127.0.0.1:idk/go-i2p $GOPATH/go/src/github.com/go-i2p/go-i2p
$GOPATH/go/src/github.com/go-i2p/go-i2p
And build with `GO111MODULES=off` or use a `replace` directive in your `go.mod`
to direct to the local module source. Or you may run your own Go Modules proxy as
a hidden service. I'll make this about a billion times easier in the near future I
promise.
### Implemented Features
As the application is restructured and moved away from representing I2P data
structures as byte slices, this chart will be filled in. Currently, much of
this is partially implemented in byte-slice versions and partially implemented
as Go Structs. Very little of it will work until it's all moved to Go Structs
where appropriate. Most of this will happen in /lib/common.
- Cryptographic primitives
- Signing
- [ ] ECDSA_SHA256_P256