Merge pull request #19 from DilumAluthge/dpa/docs-internals

Move the state machine diagram to a separate `docs/internals.md` Markdown file

Author: pfitzseb

README.md

@@ -66,6 +66,4 @@ julia> Pkg.Registry.update()
 
 ## Implementation
 
-Authentication is implemented with the following state machine:
-
-![State machine](assets/structure.png)
+For implementation details, please see [`docs/internals.md`](docs/internals.md).

bin/structure.jl

@@ -1,6 +1,12 @@
 using LightGraphs, PkgAuthentication, GraphPlot, Cairo, Compose
 
-file = joinpath(dirname(@__DIR__), "src", "PkgAuthentication.jl")
+const bin_dir = @__DIR__
+const root_dir = dirname(bin_dir)
+const src_dir = joinpath(root_dir, "src")
+const docs_dir = joinpath(root_dir, "docs")
+const docs_assets_dir = joinpath(docs_dir, "assets")
+
+file = joinpath(src_dir, "PkgAuthentication.jl")
 
 g = SimpleDiGraph()
 lines = readlines(file)
@@ -19,4 +25,4 @@ for line in lines
     end
 end
 plot = gplot(g, nodelabel=vertices, linetype="curve")
-draw(PNG(joinpath(@__DIR__, "structure.png"), 16cm, 16cm), plot)
+draw(PNG(joinpath(docs_assets_dir, "structure.png"), 16cm, 16cm), plot)

assets/structure.png renamed to docs/assets/structure.png

@@ -0,0 +1,7 @@
+# Internals
+
+## Implementation
+
+Authentication is implemented with the following state machine:
+
+![State machine](assets/structure.png)