From 3cc661542b38d7c864fd196af1ba27367f273a12 Mon Sep 17 00:00:00 2001 From: Piv <18462828+Piv200@users.noreply.github.com> Date: Tue, 22 Sep 2020 21:47:29 +0930 Subject: [PATCH] Fix readme --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9a1771c..9ca46ec 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,8 @@ This library interacts with the RPLidar A1 using pure swift. It is designed to closely replicate the python rplidar library by Skoltech: https://github.com/SkoltechRobotics/rplidar/ There may be support for RPLidar A2, however it is not available for testing at this time. -Documentation is coming soon. - For a runnable example, see the Examples product. -``` swift run --product Examples ``` +``` swift run LidarExamples ``` +Documentation can be generated using [swift-doc](https://github.com/SwiftDocOrg/swift-doc)