diff --git a/README.md b/README.md index 371eee88b..8aeeca050 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,29 @@ -# webKnossos-libs +# WEBKNOSSOS-libs [![PyPI version](https://img.shields.io/pypi/v/webknossos)](https://pypi.python.org/pypi/webknossos) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/webknossos.svg)](https://pypi.python.org/pypi/webknossos) [![Build Status](https://img.shields.io/github/actions/workflow/status/scalableminds/webknossos-libs/.github/workflows/ci.yml?branch=master)](https://github.com/scalableminds/webknossos-libs/actions?query=workflow%3A%22CI%22) [![Documentation](https://img.shields.io/badge/docs-passing-brightgreen.svg)](https://docs.webknossos.org/webknossos-py/index.html) [![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) -webKnossos Logo +WEBKNOSSOS Logo -## [webKnossos Python API](webknossos) -Python API for working with [webKnossos](https://webknossos.org) datasets, annotations, and for webKnossos server interaction. +## [WEBKNOSSOS Python API](webknossos) +Python API for working with [WEBKNOSSOS](https://webknossos.org) datasets, annotations, and for WEBKNOSSOS server interactions. Use this for: -- reading/writing/manipulating raw 2D/3D image data and volume annotations/segmentation in webKnossos wrap (*.wkw) format -- handling/manipulation of webKnossos datasets -- reading/writing/manipulating webKnossos skeleton annotations (*.nml) -- up- & downloading annotations and datasets from your webKnossos instance +- reading/writing/manipulating raw 2D/3D image data and volume annotations/segmentation in WEBKNOSSOS wrap (*.wkw) format +- handling/manipulation of WEBKNOSSOS datasets +- reading/writing/manipulating WEBKNOSSOS skeleton annotations (*.nml) +- up- & downloading annotations and datasets from your WEBKNOSSOS instance - executing any of the wkcuber operations from below from your code [Read more in the docs.](https://docs.webknossos.org/webknossos-py/) -## [webKnossos cuber (wkcuber) CLI](wkcuber) -CLI tool for creating and manipulating [webKnossos](https://webknossos.org) [WKW](https://github.com/scalableminds/webknossos-wrap) datasets. WKW is a container format for efficiently storing large-scale 3D images as found in microscopy data. +## [WEBKNOSSOS cuber (wkcuber) CLI](wkcuber) +CLI tool for creating and manipulating [WEBKNOSSOS](https://webknossos.org) [WKW](https://github.com/scalableminds/webknossos-wrap) datasets. WKW is a container format for efficiently storing large-scale 3D images as found in microscopy data. Use this for: -- converting Tiff-stacks and other data formats for volume image data to webKnossos-compatible *.wkw files from the CLI +- converting Tiff-stacks and other data formats for volume image data to WEBKNOSSOS-compatible *.wkw files from the CLI - up/downsampling of *.wkw files to different magnification levels (image pyramid) from the CLI - compressing your *.wkw files to save disk space from the CLI