From 58b1c8d8192946d571516243bf51fffbc40445e6 Mon Sep 17 00:00:00 2001 From: u8slvn Date: Mon, 12 Feb 2024 20:58:50 +0100 Subject: [PATCH] docs: update readme --- README.md | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index ba3b639..ea9fa6b 100644 --- a/README.md +++ b/README.md @@ -18,35 +18,43 @@ Does Bionic Reading really speed-up your reading speed? According to this [paper ## Usage -### Install - +### Installation ```bash pip install bionic-writer ``` ### Quickstart examples +#### Write a Bionic Reading text in Markdown format: + ```python import bionic_writer text = "Lorem ipsum dolor sit amet, consectetur adipiscing elit." -# Write a stylized Bionic Reading text in Markdown format. bionic_md = bionic_writer.write(text=text, affix="**", postfix="**") -# Write a stylized Bionic Reading text in HTML format. +print(bionic_md) +``` +Output: + +```text +**Lo**rem **ip**sum **do**lor **s**it **am**et, **conse**ctetur **adipi**scing **el**it. +``` + +#### Write a Bionic Reading text in HTML format: +```python +import bionic_writer + +text = "Lorem ipsum dolor sit amet, consectetur adipiscing elit." + bionic_html = bionic_writer.write(text=text, affix="", postfix="") -print("Markdown:\n", bionic_md, "\n") -print("HTML:\n", bionic_html) +print(bionic_html) ``` Output: ```text -Markdown: -**Lo**rem **ip**sum **do**lor **s**it **am**et, **conse**ctetur **adipi**scing **el**it. - -HTML: Lorem ipsum dolor sit amet, consectetur adipiscing elit. ```