aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJeremy Clerc <jclerc@google.com>2017-02-11 00:13:54 +0100
committerJeremy Clerc <jclerc@google.com>2017-02-12 23:54:16 +0100
commit06ee1171dee17245e71bb0ddd742c7f95f9bd2cb (patch)
tree64767087217188af49e4c3788188ce6568198fa7 /README.md
parentc42a84ae556034b9fe2f9710603b1c10e8c5588f (diff)
downloadeasypki-1.0.0.tar.xz
Refactor the all API for cleanup and extensibility.v1.0.0
API now has a store interface so one could choose to store the different files in a database for example.
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4ee2fa6..bfd7f38 100644
--- a/README.md
+++ b/README.md
@@ -56,6 +56,26 @@ For more info about available flags, checkout out the help `-h`
You will find the generated cert in `issued` and private key in `private`
+# API
+
+For the latest API:
+
+```
+import "gopkg.in/google/easypki.v1"
+```
+
+## Legacy API
+
+API below pkg/ has been rewritten to allow extensibility in terms of PKI
+storage and better readability.
+
+If you used the legacy API that was only writing files to disk, a tag has been
+applied so you can still import it:
+
+```
+import "gopkg.in/google/easypki.v0"
+```
+
# Disclaimer
This is not an official Google product