aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYaroslav de la Peña Smirnov <contact@yaroslavps.com>2018-07-18 03:21:21 +0300
committerYaroslav de la Peña Smirnov <contact@yaroslavps.com>2018-07-18 03:21:21 +0300
commit31715af3efe66654c5c372adac0d39676bb4e5ac (patch)
treeba681489971bff3cb8d55ef587d9ac8bce29d7ba /README.md
parentce34623ee6d03facb1facb2d786ee75812130810 (diff)
downloadw3blog-31715af3efe66654c5c372adac0d39676bb4e5ac.tar.gz
w3blog-31715af3efe66654c5c372adac0d39676bb4e5ac.zip
renamed to w3blog, and uploaded to pypi
Diffstat (limited to 'README.md')
-rwxr-xr-xREADME.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/README.md b/README.md
index fcf365a..c170c52 100755
--- a/README.md
+++ b/README.md
@@ -1,9 +1,11 @@
-# Weblog version 0.4 #
+# w3blog version 0.4 #
-Weblog is a simple blog engine for Django, with some focus on multilingual capabilities. It includes all of the basic features expected of a traditional Web log (also known as blog), as well as multilingual features, i.e. translations of blog posts which are delivered automatically in the user's preferred language using the internationalization capabilities of Django, enabling the possibility of targeting people from different countries in a single blog/site.
+w3blog is a simple blog engine for Django, with some focus on multilingual capabilities. It includes all of the basic features expected of a traditional Web log (also known as blog), as well as multilingual features, i.e. translations of blog posts which are delivered automatically in the user's preferred language using the internationalization capabilities of Django, enabling the possibility of targeting people from different countries in a single blog/site.
-This django app is still a work in progress. More features will be added/completed in the near future. Currently the app's strings are translated only to English (en), Russian (ru), and Spanish (es),
+This django app is still a work in progress. More features will be added/completed in the near future. Currently the app's strings are translated only to English (en), Russian (ru), and Spanish (es).
+
+To install, run "pip install w3blog". Currently tested to be compatible with Django 1.11 and 2.0.
### Quick Start ###
@@ -40,3 +42,5 @@ WEBLOG_SETTINGS = {
5. Note that if you use your own base template, you will either need to link Bootstrap (v4) in your base template's head, or write your own styles for the site based on the bootstrap classes. You will as well need to link files "weblog/css/weblog.css" and "weblog/js/weblog.js" in your html head, or write your own.
Note: This package depends on the following python packages (besides Django and their dependencies): django-summernote
+
+This project was previously named django-weblog, however, I had to renamed it due to there being an existing package with the same name in PyPI.