Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
domvwt committed Apr 8, 2021
1 parent 6d1561b commit 6aba756
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 15 deletions.
12 changes: 3 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,15 @@ esparto
[![codecov](https://codecov.io/gh/domvwt/esparto/branch/main/graph/badge.svg?token=35J8NZCUYC)](https://codecov.io/gh/domvwt/esparto)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=domvwt_esparto&metric=alert_status)](https://sonarcloud.io/dashboard?id=domvwt_esparto)


A simple toolkit for creating accessible and shareable HTML documents.
Esparto is a minimal frontend web framework written in Python.
It aims to be the first choice for designing self-contained documents with productivity as the main concern.

Full documentation available at [domvwt.github.io/esparto/](https://domvwt.github.io/esparto/).

### Features
* Lightweight API
* Familiar and accessible page format
* No CSS or HTML required
* Device responsive display
* Self contained / inline dependencies
* Jupyter Notebook support
* MIT License


This package was created with
[Cookiecutter](https://github.com/audreyr/cookiecutter) and the
[audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage)
project template.
10 changes: 6 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# Welcome
Esparto is a simple toolkit for creating accessible and shareable HTML documents.
Esparto is a minimal frontend web framework written in Python.
It aims to be the first choice for designing self-contained documents with productivity as the main concern.

## Overview
The library provides a streamlined API that lets users define their page in terms of
sections, rows, and columns; and an intelligent wrapping system that automatically
converts content to a format compatible with modern web browsers.
converts Python objects into content.

## Overview
We use the grid system and components from [Bootstrap](https://getbootstrap.com/) to ensure
documents adapt to the viewing device and appear immediately familiar and accessible.
No knowledge of Bootstrap or web development is required to use the library, however, as these
Expand All @@ -19,7 +21,7 @@ and iteratively build documents without disrupting their workflow.
## Features
* Lightweight API
* Jupyter Notebook support
* Familiar and accessible page format
* No CSS or HTML required
* Device responsive display
* Self contained / inline dependencies
* MIT License
Expand Down
7 changes: 5 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
[tool.poetry]
name = "esparto"
version = "0.1.0"
description = "Simple toolkit for building accessible and shareable HTML documents."
version = "0.1.1"
description = "Minimal frontend web framework written in Python."
authors = ["Dominic Thorn <[email protected]>"]
license = "MIT"
readme = "README.md"
homepage = "https://domvwt.github.io/esparto"
repository = "https://github.com/domvwt/esparto"

[tool.poetry.dependencies]
python = "^3.6.1"
Expand Down

0 comments on commit 6aba756

Please sign in to comment.