Skip to content

Commit c3f187d

Browse files
committed
Update README
1 parent e1a8aef commit c3f187d

File tree

1 file changed

+18
-12
lines changed

1 file changed

+18
-12
lines changed

README.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,8 @@
22

33
<div align="center"><img src="https://rawgit.com/JuliaMath/Tau.jl/master/tau-2pi.svg" width="300"/></div><br/><br/>
44

5-
[![travis][travis-img]](https://travis-ci.org/JuliaMath/Tau.jl)
6-
[![appveyor][appveyor-img]](https://ci.appveyor.com/project/waldyrious/tau-jl)
7-
[![codecov][codecov-img]](http://codecov.io/github/JuliaMath/Tau.jl)
8-
9-
[travis-img]: https://img.shields.io/travis/JuliaMath/Tau.jl/master.svg?label=Linux,%20macOS
10-
[appveyor-img]: https://img.shields.io/appveyor/ci/waldyrious/tau-jl/master.svg?label=Windows
11-
[codecov-img]: https://img.shields.io/codecov/c/github/JuliaMath/Tau.jl/master.svg?label=coverage
5+
[![CI](https://github.com/JuliaMath/Tau.jl/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/JuliaMath/Tau.jl/actions/workflows/CI.yml?query=branch%3Amaster)
6+
[![codecov](https://img.shields.io/codecov/c/github/JuliaMath/Tau.jl/master.svg?label=coverage)](http://codecov.io/github/JuliaMath/Tau.jl)
127

138
This [Julia](https://github.com/JuliaLang/julia) [package](http://pkg.julialang.org/)
149
defines the [Tau](http://www.tauday.com/tau-manifesto) constant
@@ -23,21 +18,32 @@ tau ≈ 2*pi
2318
After installing this package with `Pkg.add("Tau")`, it can be used as follows:
2419

2520
```julia
26-
using Tau
21+
julia> using Tau
22+
23+
julia> tau === τ 2*pi
24+
true
2725

28-
tau == τ 2*pi # => true
29-
typeof(tau) # => Irrational{:τ}
26+
julia> typeof(tau)
27+
Irrational{:twoπ}
3028
```
3129

3230
Note: to input the τ character, type `\tau` then press <kbd>Tab</kbd>.
3331

3432
The tau variants of `sinpi`, `cospi`, and `mod2pi` are also defined:
3533

3634
```julia
37-
sintau(1//4) # => 1.0
38-
costau(1//2) # => -1.0
35+
julia> sintau(1//4)
36+
1.0
37+
38+
julia> costau(1//2)
39+
-1.0
40+
41+
julia> modtau(9*pi/4)
42+
0.7853981633974481
3943
```
4044

45+
Alternatively, one can use the Unicode aliases `sinτ`, `cosτ`, and `modτ`.
46+
4147
## The tau != 2pi inequality
4248

4349
When this package was first created, the equality `tau == 2pi` did hold true,

0 commit comments

Comments
 (0)