Permalink
Browse files

README fixes

  • Loading branch information...
stnbu committed Sep 6, 2018
1 parent ad06efd commit d6d3620deb3a02429f02e2f68b40b6daf09f46f2
Showing with 5 additions and 8 deletions.
  1. +5 −8 README.md
@@ -6,7 +6,7 @@
A daemon that fetches and stores data locally is included.
You can see it in action here: https://unintuitive.org/portfolio/
You can see it in action here: https://unintuitive.org/pages/portfolio/
## Usage/Installation
@@ -35,13 +35,14 @@ user:read:user
```
Create a file at `~/.gitbored/API_AUTH` with contents of the form
```
github-username:api-token
```
(newlines and spaces are ignored)
Of course this file should be readable but *security is up to you*. Be careful out there.
Of course this file should be readable by the daemon but *security is up to you*. Be careful out there.
### Database changes
@@ -53,10 +54,6 @@ manage.py makemigrations gitbored && python manage.py migrate
(Don't forget to backup your data first!)
### Run the daemon
The daemon _requires_ the presence of the `DJANGO_SETTINGS_MODULE` environment variable. Set it to the name of your site's setting's module (the same value that Django calculates/expects). Note that this is the _module's name_, not its path.
@@ -113,8 +110,8 @@ Include the `gitbored` template in the body of _your_ template where appropriate
Known issues, limitations
-------------------------
* _You_ must the daemon. You may wish to use your OS's "supervisor" or similar.
* New records are never updated, so if a commit or a repository description changes for example, you'll need to go and delete the corresponding row yourself.
* _You_ must run the daemon. You may wish to use your OS's "supervisor" or similar.
* Records are never updated, so if a commit or a repository description changes for example, you'll need to go and delete the corresponding row yourself.
* The data stuff is not particularly efficient or smart. Big Data might be problematic.
* It's not very pluggable for a "plug-in" (contributions welcome!)
* You must set `myapp.settings.TEMPLATES['APP_DIRS']=True` or work out access to the template yourself.

0 comments on commit d6d3620

Please sign in to comment.