Metadata-Version: 2.1
Name: PyBook
Version: 1
Summary: Easy offline viewing of markdown projects and files
Author: dcode
Author-email: opendylan@proton.me
Requires-Python: >=3,<4
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Description-Content-Type: text/markdown

# Welcome to PyBook!

PyBook allows for easy viewing of markdown projects.

It's a great note reading app, particularly for courses and tutorials.

## Installation

``` sh
pip install pybook
```

## Using PyBook

To use PyBook, simply type `pybook` into a terminal. It's that simple.

## Importing a project

In order to import a project, click `Project > Import from...`.

To import from GitHub, just type the name of the repo (e.g. `JohnDoe/PythonTutorial`, without the `https://github.com/`).

## Enjoy!

