Cleaned up the docs and README for publication.

.gitignore

@@ -47,6 +47,7 @@ docs/_rst/*
 docs/_build/*
 cover/*
 MANIFEST
+docs/html
 
 # Per-project virtualenvs
 .venv*/

CHANGELOG.md

@@ -1,7 +1,5 @@
 # Changelog
 
-## Version 0.1 (development)
+## Version 0.0.1 
 
-- Feature A added
-- FIX: nasty bug #1729 fixed
-- add your changes here!
+- First release of the package.

README.md

@@ -4,24 +4,67 @@
 [![Built Status](https://api.cirrus-ci.com/github/<USER>/biocutils.svg?branch=main)](https://cirrus-ci.com/github/<USER>/biocutils)
 [![ReadTheDocs](https://readthedocs.org/projects/biocutils/badge/?version=latest)](https://biocutils.readthedocs.io/en/stable/)
 [![Coveralls](https://img.shields.io/coveralls/github/<USER>/biocutils/main.svg)](https://coveralls.io/r/<USER>/biocutils)
-[![PyPI-Server](https://img.shields.io/pypi/v/biocutils.svg)](https://pypi.org/project/biocutils/)
 [![Conda-Forge](https://img.shields.io/conda/vn/conda-forge/biocutils.svg)](https://anaconda.org/conda-forge/biocutils)
-[![Monthly Downloads](https://pepy.tech/badge/biocutils/month)](https://pepy.tech/project/biocutils)
 [![Twitter](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Twitter)](https://twitter.com/biocutils)
 -->
 
+# Utilities for BiocPy
+
 [![Project generated with PyScaffold](https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold)](https://pyscaffold.org/)
+[![PyPI-Server](https://img.shields.io/pypi/v/biocutils.svg)](https://pypi.org/project/biocutils/)
+[![Monthly Downloads](https://pepy.tech/badge/biocutils/month)](https://pepy.tech/project/biocutils)
+![Unit tests](https://github.com/BiocPy/biocutils/actions/workflows/pypi-test.yml/badge.svg)
+
+## Motivation
+
+This repository contains a variety of simple utilities for the [BiocPy](https://github.com/BiocPy) project,
+mostly convenient aspects of R that aren't provided by base Python.
+The aim is to simplify development of higher-level packages like [**scranpy**](https://github.com/BiocPy/scranpy) and [**singler**](https://github.com/BiocPy/singler)
+that would otherwise have to implement these methods individually.
+
+## Available utilities
+
+### `match`
+
+```python
+import biocutils
+biocutils.match(["A", "C", "E"], ["A", "B", "C", "D", "E"])
+## [0, 2, 4]
+```
+
+### `factor`
+
+```python
+import biocutils
+biocutils.factor(["A", "B", "B", "A", "C", "D", "C", "D"])
+## (['A', 'B', 'C', 'D'], [0, 1, 1, 0, 2, 3, 2, 3])
+```
 
-# biocutils
+### `intersect`
 
-> Add a short description here!
+```python
+import biocutils
+biocutils.intersect(["A", "B", "C", "D"], ["D", "A", "E"])
+## ['A', 'D']
+```
 
-A longer description of your project goes here...
+### `union`
 
+```python
+import biocutils
+biocutils.union(["A", "B", "C", "D"], ["D", "A", "E"])
+## ['A', 'B', 'C', 'D', 'E']
+```
 
-<!-- pyscaffold-notes -->
+### `subset`
 
-## Note
+```python
+import biocutils
+biocutils.subset(["A", "B", "C", "D", "E"], [0, 2, 4])
+## ['A', 'C', 'E']
 
-This project has been set up using PyScaffold 4.5. For details and usage
-information on PyScaffold see https://pyscaffold.org/.
+import numpy as np
+y = np.array([10, 20, 30, 40, 50])
+biocutils.subset(y, [0, 2, 4])
+## array([10, 30, 50])
+```

docs/index.md

@@ -1,18 +1,6 @@
-# biocutils
-
-Add a short description here!
-
-
-## Note
-
-> This is the main page of your project's [Sphinx] documentation. It is
-> formatted in [Markdown]. Add additional pages by creating md-files in
-> `docs` or rst-files (formatted in [reStructuredText]) and adding links to
-> them in the `Contents` section below.
->
-> Please check [Sphinx] and [MyST] for more information
-> about how to document your project and how to configure your preferences.
+# BiocUtils
 
+Common utilities for BiocPy, mostly to mimic convenient aspects of base R.
 
 ## Contents