Skip to content

Commit

Permalink
docs: add link to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@umonaca
umonaca committed Nov 18, 2021
1 parent de37efd commit 1984479
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OBPlatform

A package to interact and download behavior data from ASHRAE OB Database. Currently available on PyPI. More features coming in the furture.
A package to interact and download behavior data from [ASHRAE Global Occupant Behavior Database](https://ashraeobdatabase.com). Currently available on PyPI. More features coming in the furture.

[![pypi](https://img.shields.io/pypi/v/obplatform.svg)](https://pypi.python.org/pypi/obplatform) [![CI](https://github.com/umonaca/obplatform/actions/workflows/test.yml/badge.svg?event=push)](https://github.com/umonaca/obplatform/actions?query=event%3Apush+branch%3Amaster) [![codecov](https://codecov.io/gh/umonaca/obplatform/branch/master/graph/badge.svg?token=SCFFFX2IKX)](https://codecov.io/gh/umonaca/obplatform) ![license](https://img.shields.io/github/license/umonaca/obplatform) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/obplatform) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) ![Read the Docs](https://img.shields.io/readthedocs/obplatform)

Expand Down
6 changes: 3 additions & 3 deletions README.rst
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
OBPlatform
==========

A package to interact and download behavior data from ASHRAE OB
Database. Currently available on PyPI. More features coming in the
furture.
A package to interact and download behavior data from `ASHRAE Global
Occupant Behavior Database <https://ashraeobdatabase.com>`__. Currently
available on PyPI. More features coming in the furture.

|pypi| |CI| |codecov| |license| |PyPI - Python Version| |Code style:
black| |Read the Docs|
Expand Down
6 changes: 3 additions & 3 deletions docs/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ OBPlatform
======================================


A package to interact and download behavior data from ASHRAE OB
Database. Currently available on PyPI. More features coming in the
furture.
A package to interact and download behavior data from `ASHRAE Global
Occupant Behavior Database <https://ashraeobdatabase.com>`__. Currently
available on PyPI. More features coming in the furture.

|pypi| |CI| |codecov| |license| |PyPI - Python Version| |Code style:
black| |Read the Docs|
Expand Down

0 comments on commit 1984479

Please sign in to comment.