Update README.md

README.md

@@ -1,60 +1,14 @@
-<div align="center">
-  <img src="./docs/src/assets/logo.png" height="200"><br>
-</div>
-
-# To be deprecated: This package will be replaced by [`EquationsOfStateOfSolids.jl`](https://github.com/MineralsCloud/EquationsOfStateOfSolids.jl)!
-
-# EquationsOfState.jl
+# EquationsOfState
 
+[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://MineralsCloud.github.io/EquationsOfState.jl/stable)
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://MineralsCloud.github.io/EquationsOfState.jl/dev)
 [![Build Status](https://github.com/MineralsCloud/EquationsOfState.jl/workflows/CI/badge.svg)](https://github.com/MineralsCloud/EquationsOfState.jl/actions)
-[![Build Status](https://travis-ci.com/MineralsCloud/EquationsOfState.jl.svg?branch=master)](https://travis-ci.com/MineralsCloud/EquationsOfState.jl)
-[![Build Status](https://ci.appveyor.com/api/projects/status/mqfsm1ssxergkmec?svg=true)](https://ci.appveyor.com/project/singularitti/EquationsOfState-jl)
+[![Build Status](https://ci.appveyor.com/api/projects/status/github/MineralsCloud/EquationsOfState.jl?svg=true)](https://ci.appveyor.com/project/MineralsCloud/EquationsOfState-jl)
 [![Build Status](https://cloud.drone.io/api/badges/MineralsCloud/EquationsOfState.jl/status.svg)](https://cloud.drone.io/MineralsCloud/EquationsOfState.jl)
 [![Build Status](https://api.cirrus-ci.com/github/MineralsCloud/EquationsOfState.jl.svg)](https://cirrus-ci.com/github/MineralsCloud/EquationsOfState.jl)
 [![Coverage](https://codecov.io/gh/MineralsCloud/EquationsOfState.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/MineralsCloud/EquationsOfState.jl)
-[![Coverage](https://coveralls.io/repos/github/MineralsCloud/EquationsOfState.jl/badge.svg?branch=master)](https://coveralls.io/github/MineralsCloud/EquationsOfState.jl?branch=master)
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://MineralsCloud.github.io/EquationsOfState.jl/stable)
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://MineralsCloud.github.io/EquationsOfState.jl/dev)
-[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
-
-This package implements some _equations of state_ (EOS) of solids which are
-useful in research. It currently includes:
-
-1. `Murnaghan` EOS
-2. Birch–Murnaghan EOS family:
-   1. `BirchMurnaghan2nd`
-   2. `BirchMurnaghan3rd`
-   3. `BirchMurnaghan4th`
-   4. `BirchMurnaghan5th`
-3. `Vinet` EOS
-4. Poirier–Tarantola EOS family:
-   1. `PoirierTarantola2nd`
-   2. `PoirierTarantola3rd`
-   3. `PoirierTarantola4th`
-   4. `PoirierTarantola5th`
-5. `AntonSchmidt` EOS (experimental)
-6. `BreenanStacey` EOS (experimental)
-
-The formulae are referenced from Ref. 1.
-
-This package also includes linear and nonlinear fitting methods, also referenced
-from Ref. 1.
-
-See its
-[documentation](https://mineralscloud.github.io/EquationsOfState.jl/stable/).
-
-## Compatibility
-
-- [Julia version: `v1.0.0` and above](https://julialang.org/downloads/)
-- Dependencies: see `Project.toml` [`deps` field](Project.toml#L7-L14) and
-  [`compat` field](Project.toml#L16-L21)
-- OS: macOS, Linux, and Windows
-
-## TODOs
-
-- [ ] Implement nonlinear fitting using
-      [CMPFit.jl](https://github.com/gcalderone/CMPFit.jl).
-
-## References
 
-1. [A. Otero-De-La-Roza, V. Luaña, _Comput. Phys. Commun._ **182**, 1708–1720 (2011).](https://www.sciencedirect.com/science/article/pii/S0010465511001470)
+Note: starting from version `v4.0.0`, we will move all the past functionalities to package
+[`EquationsOfStateOfSolids.jl`](https://github.com/MineralsCloud/EquationsOfStateOfSolids.jl).
+This package is only served as a "base" package or a high-level package for similar packages.
+To use the previous functionalities, please use `EquationsOfStateOfSolids.jl`.