aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md44
1 files changed, 15 insertions, 29 deletions
diff --git a/README.md b/README.md
index 9073e7f..f920a88 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,18 @@
-Beautiful Custom Start Page
-===
-BCST allow you to create a beautiful start page very quickly. To install the dependencies, simply run:
+# Beautiful Custom Start Page
- > pip install jinja2
+### Basic usage
+**bcst** allow you to create a beautiful start page very quickly. To install **bcst** run
+`pip install bcst`. Then choose a theme (screenshots are availaible on the package repository):
+> bcst -l
+>
+Next step, extract the theme resources:
+> bcst -e \<your-theme>
-Simple write a simple json resource file:
-```
-{
- "title":"Default Theme",
- "bookmarks":{
- "engines":{
- "Qwant":"https://www.qwant.com/",
- "DDG":"https://duckduckgo.com/",
- "Google":"http://google.fr"
- },
- "Reddit":{
- "Home":"https://www.reddit.com/",
- "Unixporn":"https://www.reddit.com/r/Unixporn",
- "Linux":"https://www.reddit.com/me/m/linux"
- },
- "Social":{
- "Discord":"https://discordapp.com/channels/@me",
- "Twitter":"https://twitter.com/",
- "LinuxRocks":"https://linuxrocks.online/web/getting-started"
- }
- }
-}
-```
-Then simply run:
+This, will create a `resources.json` in the current directory. Now, you can customize it to your needs. Then, generate your start page:
+> bcst resources.json \<start-page-destination>
+
+VoilĂ !
+
+### Submit your own theme
+TODO
-> ./src/bcst.py \<resource-file-path> \<start-page-destination>