From b37cece797801366c31dd85715aefe1ff6c4144b Mon Sep 17 00:00:00 2001 From: James Varndell Date: Thu, 29 Aug 2024 10:45:51 +0100 Subject: [PATCH] Improves README --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/README.md b/README.md index 1b2aa66..88182af 100644 --- a/README.md +++ b/README.md @@ -1 +1,44 @@ # earthkit-plots + +[![PyPI version fury.io](https://badge.fury.io/py/earthkit-plots.svg)](https://pypi.python.org/pypi/earthkit-plots/) +[![PyPI pyversions](https://img.shields.io/pypi/pyversions/earthkit-plots.svg)](https://pypi.python.org/pypi/earthkit-plots/) + +**DISCLAIMER** + +> This project is in the **BETA** stage of development. Please be aware that interfaces and functionality may change as the project develops. If this software is to be used in operational systems you are **strongly advised to use a released tag in your system configuration**, and you should be willing to accept incoming changes and bug fixes that require adaptations on your part. ECMWF **does use** this software in operations and abides by the same caveats. + +Visualisation tools and templates designed for earth science data. + +## Documentation + +The documentation can be found at https://earthkit-plots.readthedocs.io/. + +## Install + +Install via `pip` with: + +``` +$ pip install earthkit-plots +``` + +## License + +``` +Copyright 2022, European Centre for Medium Range Weather Forecasts. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + +In applying this licence, ECMWF does not waive the privileges and immunities +granted to it by virtue of its status as an intergovernmental organisation +nor does it submit to any jurisdiction. +```