- Global deps:
- Local packages can be installed by running
make depsin your terminal.
You'll then need to authorize twurl by in your terminal of your choice.
CON_KEY=TW_CONSUMER_KEY CON_SECRET=TW_CONSUMER_SECRET make authThat's it!
You'd point your github/gitlab hooks to http://changelog.MY-DOMAIN.TLD/githook (You'd reverse proxy from localhost:4000, this can be done using nginx)
Compile the tool by:
make compileRun on port 4000 (also w/ a repo path, if you dare):
./tinylog -p:4000 -d:~/repos/tinylog -t:23OR
Run make run to compile and run directly still on port 4000.
If you run it with a path to any repo, it'll fetch all the commits since yesterday, put them in the data-folder and tweet it out at 11pm, as specified below.
It'll handle everything for you 😍
You can now start enjoying tinylog 😇
p,port:int- any port to start the server on.- std:
4000
- std:
d,dir,directory:path- specify which repo-path to look at.- std:
""
- std:
t,time:int- any number between0&23. Which will then correspond to what time to fetch data and tweet it.- std:
23 - Also, take a look at the Post Scriptum.
- std:
dump- dump the image and quittweet- same as above, but tweet before quit
You commit as usual and it'll tweet your commits every day at 11pm, as an image. Easy as that!
Tinylog exposes some url-paths from standard:
/lazy- for lazy-loading/all- to check files exposed to the public/*- to every file in the static folder
/githook- for when a new commit is pushed/next- fetch the next entry- body should be in the format of
yyyymmdd
- body should be in the format of
/prev- fetch the previous entry- body should be in the format of
yyyymmdd
- body should be in the format of
/newest- [REMOVED] fetch the newest log-entry-name/*- a json msg
To make a new entry in your logs simply in your git commit:
``` @fix Did __this__ thing, that fixed _that_ broken [thing](https://example.com) ```
Or create/edit the files in site/data using the pattern yyyymmdd.tl, using that same structure, though, you should omit the back-ticks.
The @fix is probably the most importan thing, it's like tags for what you've done. Thus far you can choose from:
- fix
- new
- bug
Just remember to put the at-sign (@) in front of them.
Other than that, we've got a few goodies from markdown.
- The
bold=>__WORD__||**WORD**=> WORD - The
code=> single backtick in front and behind the code =>code - The
emphasis=>_WORD_||*WORD*=> WORD - The
link=>[text](link)=> text - The
strike=>~~WORD~~=>WORD
If you use the cli-opt d, dir or directory, you'd not connect your repo to the hook. This tool will handle that for you. By checking the local repo, and fetching the commits from that.