add api docs

fluency03 · Apr 29, 2018 · 8c983df · 8c983df
1 parent e4db873
commit 8c983df
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -12,3 +12,11 @@ Inspired by:
 - [Naivecoin](https://github.com/lhartikk/naivecoin) of [@lhartikk](https://github.com/lhartikk)
 
 REST API service is built on the open source projects [akka](https://github.com/akka/akka) and [akka-http](https://github.com/akka/akka-http).
+
+API Documentation on Postman: [blockchain-in-scala](https://documenter.getpostman.com/view/1231202/blockchain-in-scala/RVu8iTUP)
+
+Start the service, run the following Class:
+
+```
+com.fluency03.blockchain.api.Server
+```
diff --git a/src/main/scala/com/fluency03/blockchain/api/routes/BlockchainRoutes.scala b/src/main/scala/com/fluency03/blockchain/api/routes/BlockchainRoutes.scala
@@ -26,7 +26,6 @@ trait BlockchainRoutes extends RoutesSupport {
    *  - GetTransactionOfABlock
    *  - MineNextBlock
    *
-   *
    */
 
   lazy val blockchainRoutes: Route =
-Original file line number
+Diff line change
@@ Expand Up / @@ -26,7 +26,6 @@ trait BlockchainRoutes extends RoutesSupport { @@
        *  - GetTransactionOfABlock
        *  - MineNextBlock
        *
-       *
        */
       lazy val blockchainRoutes: Route =
@@ Expand Down @@