Skip to content

Commit

Permalink
Merge pull request #26 from JuliaPhysics/readme-improvements
Browse files Browse the repository at this point in the history
Readme improvements
  • Loading branch information
carstenbauer authored Oct 3, 2019
2 parents cc4433d + 4b00e7f commit ec7a827
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,15 @@

# PeriodicTable.jl
A very simple package for accessing elements in the Periodic Table! :fire:

https://github.com/lancebeet/julia-scripts#periodictabletoyjl
### Installation
Since PeriodicTable is registered in `METADATA.jl`, you can directly install it like,
Since PeriodicTable is registered in Julia's [General Registry](https://github.com/JuliaRegistries/General), you can readily install it with
```julia
julia> using Pkg
julia> Pkg.add("PeriodicTable")
] add PeriodicTable
```


### How it works?
### Usage
PeriodicTable.jl provides a Julia interface to a small database of element
properties for all of the elements in the periodic table. In particular `PeriodicTable` exports a global variable called `elements`, which is a collection of
`Element` data structures.
Expand Down Expand Up @@ -78,6 +77,8 @@ julia> elements[1:4]
Element(Lithium)
Element(Beryllium)
```

A nice interactive visualization of the periodic table, based on PeriodicTable.jl, can be found [here](https://github.com/JuliaRegistries/General).

### Data by
The data used for this package has been pulled up in parts from [here](https://github.com/Bowserinator/Periodic-Table-JSON).
Expand Down

0 comments on commit ec7a827

Please sign in to comment.