# zenchi-github-readme

> **Description**: The ZenChi GitHub Readme component uses a raw file of GitHub markdown and recreates a facsimile of how GitHub displays markdown

Latest version **0.1.1** (published 2018-11-29) · (ISC OR GPL-3.0) license · 0 weekly downloads

## Install

```sh
npm install zenchi-github-readme
pnpm add zenchi-github-readme
yarn add zenchi-github-readme
bun add zenchi-github-readme
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2018-11-29 |
| First published | 2018-11-29 |
| Weekly downloads | 0 |
| License | (ISC OR GPL-3.0) |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 55.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | chimera.zen |

## Links

- npm: https://www.npmjs.com/package/zenchi-github-readme
- Repository: https://github.com/ChimeraZen/zenchiapps
- Homepage: https://github.com/ChimeraZen/zenchiapps#readme
- Issues: https://github.com/ChimeraZen/zenchiapps/issues
- npm.io page: https://npm.io/package/zenchi-github-readme

## Dependencies (4)

- [react](https://npm.io/package/react.md) ^16.6.1
- [react-dom](https://npm.io/package/react-dom.md) ^16.6.1
- [prop-types](https://npm.io/package/prop-types.md) ^15.6.2
- [react-scripts](https://npm.io/package/react-scripts.md) 2.1.1

## Recent versions

- 0.1.1 (latest) — 2018-11-29

## README

# ZenChi GitHub Readme
  
**Description**:  The ZenChi GitHub Readme component uses a raw file of GitHub markdown and recreates a facsimile of how GitHub displays markdown

**Version**:      [0.1.1](#v011)  
**Author**:       Elijah Liedtke (Chimera.Zen)  
**Email**:        [chimera.zen@gmail.com](mailto:chimera.zen@gmail.com)  
**Link**:         https://github.com/ChimeraZen/zenchi-github-readme

**Copyright**:    Copyright (c) 2018, Elijah Liedtke  
**License**:      http://www.gnu.org/licenses/old-licenses/gpl-2.0.html

## Table of Contents
1. [Instructions](#instructions)
    1. [Installation](#installation)
    2. [Updating](#updating)
    3. [Uninstall](#uninstall)
2. [Components](#components)
    1. [Progress](#progress)
3. [ChangeLog](#changelog)

---

## Instructions
The following has been provided to assist in installing, updating or removing the ZenChi (pronounced: *zen-Kai*) Apps. Questions, comments, suggestions and concerns are welcome and can be sent to [chimera.zen@gmail.com](mailto:chimera.zen@gmail.com).

I hope you enjoy this app!

 
### Installation
1. Navigate to your app directory and install the ZenChi GitHub Readme package using:
```
npm i zenchi-github-readme
```
2. Once installed, ZenChi components can be imported using this syntax:
```
import { GitHubReadme } from 'github-readme'
```
 
### Updating
1. Navigate to your app directory and enter:
```
npm update zenchi-github-readme
```
 
### Uninstall
1. Navigate to your app directory and enter:
```
npm uninstall zenchi-github-readme
```

 
## Components

### Progress
The ZenChi GitHub Readme component uses a raw file of GitHub markdown and recreates a facsimile of how GitHub displays markdown. The file can be an import or fetched from the raw URL provided by GitHub

This component can be initialized using `import { GitHubReadme } from 'zenchi-github-readme'`

```  
<GitHubReadme file={raw-github-readme-file-as-string} />
```


### Parameters

Name        |Type     |Default|Syntax                                      |Description
------------|---------|-------|--------------------------------------------|-------------------------------
file        |string   |       |                                            |File can be imported or fetched from raw readme URL on GitHub


&nbsp;
## ChangeLog
### v0.1.1
* Parses raw GitHub Readme file as string and outputs a facsimile of how GitHub displays readme.md files
* Some issues with parsing task lists, etc. and some styling isn't quite right



### v0.1.0
* Initial Commit and NPM package test

---
_Source: https://npm.io/package/zenchi-github-readme · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._