apollo/bookbot
1
0
Fork 0
mirror of https://github.com/dananglin/bookbot.git synced 2024-09-16 20:12:32 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs: update README.md

Browse source
This commit is contained in:
Dan Anglin 2024-02-03 06:44:08 +00:00
parent f179081e82
commit 7e894859d9
Signed by: dananglin
GPG key ID: 0C1D44CFBEE68638
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -2,7 +2,10 @@
### Summary
Bookbot reads a book from a text file and prints a simple book report to the standard output.
Bookbot reads a book from a text file,
counts the number of words and characters in the book
and prints the results in a simple book report to the
standard output (console screen).
### Requirements
@ -27,7 +30,7 @@ Download a book in text format (e.g. txt, markdown, etc).
As an example you can download the free ebook called `Frankenstein or The Modern Prometheus` from [here](https://raw.githubusercontent.com/asweigart/codebreaker/master/frankenstein.txt).
```sh
mkdir books
mkdir -p books
curl -L https://raw.githubusercontent.com/asweigart/codebreaker/master/frankenstein.txt -o books/frankenstein.txt
```