From b032443dee5f08792dd545c783ecde6d35968a61 Mon Sep 17 00:00:00 2001 From: richard gowers Date: Tue, 5 Mar 2024 14:36:49 +0000 Subject: [PATCH] docs: update badge on front page This badge should point to stable/released docs, so people are linked to what documents the thing that they are most likely to be using. Most people will be using conda builds, not dev/source builds, if they're using dev builds they'll also know how to get to the dev docs. Removed disclaimer on pre-alpha status, we're 1.0rc --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 02b364ab5..20e914f39 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ [![Logo](https://img.shields.io/badge/OSMF-OpenFreeEnergy-%23002f4a)](https://openfree.energy/) [![build](https://github.com/OpenFreeEnergy/openfe/actions/workflows/ci.yaml/badge.svg?event=schedule)](https://github.com/OpenFreeEnergy/openfe/actions/workflows/ci.yaml) [![coverage](https://codecov.io/gh/OpenFreeEnergy/openfe/branch/main/graph/badge.svg)](https://codecov.io/gh/OpenFreeEnergy/openfe) -[![documentation](https://readthedocs.org/projects/openfe/badge/?version=latest)](https://openfe.readthedocs.io/en/latest/?badge=latest) +[![documentation](https://readthedocs.org/projects/openfe/badge/?version=stable)](https://docs.openfree.energy/en/stable/?badge=stable) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8344248.svg)](https://doi.org/10.5281/zenodo.8344248) @@ -12,17 +12,14 @@ a pre competitive consortium aiming to provide robust, permissively licensed ope Using `openfe` you can easily plan and execute alchemical free energy calculations. -See our [website](https://openfree.energy/) for more information, -or [try for yourself](https://try.openfree.energy) from the comfort of your browser. +See our [website](https://openfree.energy/) for more information on the project, +[try for yourself](https://try.openfree.energy) from the comfort of your browser, +and we have [documentation on using the package](https://docs.openfree.energy/en/latest/index.html). ## License This library is made available under the [MIT](https://opensource.org/licenses/MIT) open source license. -## Important note - -This is pre-alpha work, it should not be considered ready for production and API changes are expected at any time without prior warning. - ## Install ### Latest release