diff --git a/README.md b/README.md index 5ed4924..7e94f00 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,24 @@ # Abstraction -This is temporary repo for better abstraction calls for the Peernet core repo. This is expected to be deprecated once the core officially supports strong abstractions. +> **_NOTE:_** This is temporary repo for better abstraction calls for the Peernet core repo. This is expected to be deprecated once the core officially supports strong abstractions. + +The following repo was created for the GoAdvent blog post. The objective to prove how easy it's to extend your Go application with p2p capabilites +using Peernet. + +## Function calls supported +### Search a file: +```go +Abstrations.Search(&, "space") +``` +### Downloading a file +```go +Abstrations.Download(&,,,) +``` +### Add a file to peernet +```go +Abstrations.Touch(&, ) +``` + +### Remove a file to peernet +```go +Abstrations.Rm(&, ) +```