Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Closes issue #8.
  • Loading branch information
ahojukka5 committed Jul 24, 2018
1 parent bc19de9 commit 32cbf10
Showing 1 changed file with 39 additions and 2 deletions.
41 changes: 39 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,21 @@
# BoundingSphere

[![Build Status](https://travis-ci.org/JuliaFEM/BoundingSphere.jl.svg?branch=master)](https://travis-ci.org/JuliaFEM/BoundingSphere.jl)
[![codecov.io](https://codecov.io/github/JuliaFEM/BoundingSphere.jl/coverage.svg?branch=master)](http://codecov.io/github/JuliaFEM/BoundingSphere.jl?branch=master)
[![][travis-img]][travis-url]
[![][pkg-0.6-img]][pkg-0.6-url]
[![][pkg-0.7-img]][pkg-0.7-url]
[![][coveralls-img]][coveralls-url]
[![][docs-stable-img]][docs-stable-url]
[![][docs-latest-img]][docs-latest-url]
[![][issues-img]][issues-url]

Package contains algorithms to calculate smallest enclosing sphere for a given
set of points in N dimensions.

BoundingSphere.jl is a complete rewrite from scratch of [Miniball.jl](https://github.com/JuliaFEM/Miniball.jl).
See [Miniball.jl issue #28](https://github.com/JuliaFEM/Miniball.jl/issues/28).

## Usage

```julia
using BoundingSphere

Expand All @@ -14,3 +27,27 @@ pts = [@SVector(randn(3)) for _ in 1:10] # use static arrays for performance
algorithm = Ritter() # fast but inaccurate
center, radius = boundingsphere(pts, algorithm) # customize algorithm
```

[contrib-url]: https://juliafem.github.io/BoundingSphere.jl/latest/man/contributing/
[discourse-tag-url]: https://discourse.julialang.org/tags/boundingsphere
[gitter-url]: https://gitter.im/JuliaFEM/JuliaFEM.jl

[docs-latest-img]: https://img.shields.io/badge/docs-latest-blue.svg
[docs-latest-url]: https://juliafem.github.io/BoundingSphere.jl/latest

[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
[docs-stable-url]: https://juliafem.github.io/BoundingSphere.jl/stable

[travis-img]: https://travis-ci.org/JuliaFEM/BoundingSphere.jl.svg?branch=master
[travis-url]: https://travis-ci.org/JuliaFEM/BoundingSphere.jl

[coveralls-img]: https://coveralls.io/repos/github/JuliaFEM/BoundingSphere.jl/badge.svg?branch=master
[coveralls-url]: https://coveralls.io/github/JuliaFEM/BoundingSphere.jl?branch=master

[issues-img]: https://img.shields.io/github/issues/JuliaFEM/BoundingSphere.jl.svg
[issues-url]: https://github.com/JuliaFEM/BoundingSphere.jl/issues

[pkg-0.6-img]: http://pkg.julialang.org/badges/BoundingSphere_0.6.svg
[pkg-0.6-url]: http://pkg.julialang.org/?pkg=BoundingSphere&ver=0.6
[pkg-0.7-img]: http://pkg.julialang.org/badges/BoundingSphere_0.7.svg
[pkg-0.7-url]: http://pkg.julialang.org/?pkg=BoundingSphere&ver=0.7

0 comments on commit 32cbf10

Please sign in to comment.