Skip to content

Commit

Permalink
Add link to GitHub pages Jazzy docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
jbadger3 committed Jun 1, 2020
1 parent 3fa0369 commit 30e5efd
Showing 1 changed file with 2 additions and 5 deletions.
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ If you are using Xcode you can do the following:
5. Click Finish.

## Usage
Using SwiftAnnoy is fairly straitforward. You can follow the code snippets below to get started.
Using SwiftAnnoy is fairly straitforward. You can follow the code snippets below to get started or have a look at the Jazzy generated [docs](https://jbadger3.github.io/SwiftAnnoy/)

### Create an index
First, create an `AnnoyIndex<T>` as in:
Expand Down Expand Up @@ -76,9 +76,6 @@ print(results2)
"Optional((indices: [2, 0, 1], distances: [0.0, 3.605551275463989, 3.605551275463989]))"
```




## Contributing
Improvements and suggestions are welcome. Have a look at the TODO list below or open up an issue for other areas of improvement.

Expand All @@ -87,7 +84,7 @@ Improvements and suggestions are welcome. Have a look at the TODO list below or
### Features
- [ ] hamming distance
- [ ] bounds checking for getItem, getNNsForItem, and getNNsForVector
- [ ]
- [ ] half-precision support

### Unit testing
- [ ] build
Expand Down

0 comments on commit 30e5efd

Please sign in to comment.