Skip to content

Commit

Permalink
Use markdown for README [ci skip]
Browse files Browse the repository at this point in the history
Github's RST rendering is currently broken [1]: does not support image sizing or multiple images per line.
PyPI now supports markdown, so we can switch to harmonize with TileDB
core repo.

[1] github/markup#295
  • Loading branch information
ihnorton committed Mar 9, 2020
1 parent cdbd84c commit 670ff3c
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 39 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<a href="https://tiledb.com"><img src="https://github.com/TileDB-Inc/TileDB/raw/dev/doc/source/_static/[email protected]" alt="TileDB logo" width="400"></a>


[![Build Status](https://dev.azure.com/TileDB-Inc/CI/_apis/build/status/TileDB-Inc.TileDB-Py?branchName=dev)](https://dev.azure.com/TileDB-Inc/CI/_build/latest?definitionId=1&branchName=dev)
![](https://raw.githubusercontent.com/TileDB-Inc/TileDB/dev/doc/anaconda.svg?sanitize=true)[![Anaconda download count badge](https://anaconda.org/conda-forge/TileDB-Py/badges/downloads.svg)](https://anaconda.org/conda-forge/TileDB-Py)


# TileDB-Py

*TileDB-Py* is a [Python](https://python.org) interface to the [TileDB Storage Engine](https://github.com/TileDB-Inc/TileDB).

# Quick Links

* [Installation](https://docs.tiledb.com/developer/installation/quick-install)
* [Quickstart](https://docs.tiledb.com/developer/quickstart)
* [API reference](https://tiledb-inc-tiledb-py.readthedocs-hosted.com/en/stable)
* [Full developer documentation for all APIs and integrations](https://docs.tiledb.com/developer)

# Quick Installation

TileDB-Py can be installed with either `conda <https://conda.io/docs/>`_ (recommended)::

> conda install -c conda-forge tiledb-py
or ``pip``::

> pip install tiledb
39 changes: 0 additions & 39 deletions README.rst

This file was deleted.

0 comments on commit 670ff3c

Please sign in to comment.