Skip to content

Commit aa53ae7

Browse files
authored
Merge pull request #47 from SomaticLabs/add-documentation-notes
Describe documentation in README
2 parents 8010296 + 2b68051 commit aa53ae7

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,12 @@ device.connect { result in
207207

208208
Contributions to this project should conform to the [Swift API Design Guidelines](https://swift.org/documentation/api-design-guidelines/) and [this style guide](https://github.com/github/swift-style-guide).
209209

210+
## Documentation
211+
212+
To learn about code documentation for Swift, check out [this guide](http://nshipster.com/swift-documentation/)
213+
214+
We build our documentation pages with [Jazzy](https://github.com/realm/jazzy), to create docs from your well commented code, just run `jazzy`
215+
210216
## License
211217

212218
The SwiftyZorb is released under the [GPL license](https://github.com/SomaticLabs/SwiftyZorb/blob/master/LICENSE).

0 commit comments

Comments
 (0)