convert rst to md file to github recognition

CODE_OF_CONDUCT.rst → CODE_OF_CONDUCT.md

@@ -1,8 +1,6 @@
-Contributor Covenant Code of Conduct
-====================================
+# Contributor Covenant Code of Conduct
 
-Our Pledge
-----------
+## Our Pledge
 
 We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for
 everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity
@@ -11,8 +9,7 @@ or sexual identity and orientation.
 
 We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
 
-Our Standards
--------------
+## Our Standards
 
 Examples of behavior that contributes to a positive environment for our community include:
 
@@ -30,8 +27,7 @@ Examples of unacceptable behavior include:
 * Publishing others' private information, such as a physical or email address, without their explicit permission
 * Other conduct which could reasonably be considered inappropriate in a professional setting
 
-Enforcement Responsibilities
-----------------------------
+## Enforcement Responsibilities
 
 Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take
 appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive,
@@ -41,39 +37,34 @@ Community leaders have the right and responsibility to remove, edit, or reject c
 issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for
 moderation decisions when appropriate.
 
-Scope
------
+## Scope
 
 This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing
 the community in public spaces. Examples of representing our community include using an official e-mail address, posting
 via an official social media account, or acting as an appointed representative at an online or offline event.
 
-Enforcement
------------
+## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible
-for enforcement at `zhengp@uw.edu <zhengp@uw.edu>`_.
-All complaints will be reviewed and investigated promptly and fairly.
+for enforcement at
+[INSERT CONTACT METHOD]. All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the reporter of any incident.
 
-Enforcement Guidelines
-----------------------
+## Enforcement Guidelines
 
 Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem
 in violation of this Code of Conduct:
 
-1. Correction
-~~~~~~~~~~~~~
+### 1. Correction
 
 **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the
 community.
 
 **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation
 and an explanation of why the behavior was inappropriate. A public apology may be requested.
 
-2. Warning
-~~~~~~~~~~
+### 2. Warning
 
 **Community Impact**: A violation through a single incident or series of actions.
 
@@ -82,32 +73,39 @@ unsolicited interaction with those enforcing the Code of Conduct, for a specifie
 interactions in community spaces as well as external channels like social media. Violating these terms may lead to a
 temporary or permanent ban.
 
-3. Temporary Ban
-~~~~~~~~~~~~~~~~
+### 3. Temporary Ban
 
 **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
 
 **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified
 period of time. No public or private interaction with the people involved, including unsolicited interaction with those
 enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
 
-4. Permanent Ban
-~~~~~~~~~~~~~~~~
+### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate
 behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within the community.
 
-Attribution
------------
+## Attribution
 
-This Code of Conduct is adapted from the `Contributor Covenant <https://www.contributor-covenant.org>`_,
-version 2.0, available at `<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>`_.
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
 
 Community Impact Guidelines were inspired by
-`Mozilla's code of conduct enforcement ladder <https://github.com/mozilla/diversity>`_.
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
 
 For answers to common questions about this code of conduct, see the FAQ at
-`<https://www.contributor-covenant.org/faq>`_. Translations are available
-at `<https://www.contributor-covenant.org/translations>`_.
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+
+[Mozilla CoC]: https://github.com/mozilla/diversity
+
+[FAQ]: https://www.contributor-covenant.org/faq
+
+[translations]: https://www.contributor-covenant.org/translations

README.md

@@ -0,0 +1,15 @@
+[![license](https://img.shields.io/github/license/ihmeuw-msca/xspline)](https://github.com/ihmeuw-msca/xspline/blob/main/LICENSE)
+[![version](https://img.shields.io/pypi/v/xspline)](https://pypi.org/project/xspline)
+[![build](https://img.shields.io/github/actions/workflow/status/ihmeuw-msca/xspline/python-build.yml?branch=main)](https://github.com/ihmeuw-msca/xspline/actions)
+[![docs](https://img.shields.io/badge/docs-here-green)](https://ihmeuw-msca.github.io/xspline)
+[![codecov](https://img.shields.io/codecov/c/github/ihmeuw-msca/xspline)](https://codecov.io/gh/ihmeuw-msca/xspline)
+[![codacy grade](https://img.shields.io/codacy/grade/f1646d62d6764e77a59d6c71df262ed4)](https://app.codacy.com/gh/ihmeuw-msca/xspline/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
+
+
+# XSpline
+
+Advanced spline package that provides b-spline bases, their derivatives and integrals.
+
+
+* [Installation](https://ihmeuw-msca.github.io/xspline/installation.html)
+* [Quickstart](https://ihmeuw-msca.github.io/xspline/quickstart.html)