code.ivysaur.me/yatwiki
1
0
Fork 0
Code Issues Pull Requests Releases Activity

doc: top-level README.md

Browse Source
This commit is contained in:
mappu 2018-12-31 18:56:19 +13:00
parent f2a69d1ed7
commit 206ea45115
1 changed files with 14 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
_dist/README.txt → README.md
View File

@ -1,10 +1,8 @@
# YATWiki
A semi-anonymous wiki for use in trusted environments.
For the 20150901 release, a desktop version is available for Windows (based on PHPDesktop).
As of the 3.0 release, YATWiki is now a standalone server instead of a PHP script.
=FEATURES=
## Features
- Standalone server, easy to run
- Built-in SQLite database
@ -13,28 +11,26 @@ As of the 3.0 release, YATWiki is now a standalone server instead of a PHP scrip
- RSS changelog
- IP-based ban system
- Article index, random article, download database backup
- Source code highlighting (thanks [url=https://github.com/isagalaev/highlight.js]highlight.js[/url])
- Optional integration with `contented` for file/image uploads
- Source code highlighting (thanks [highlight.js](https://github.com/isagalaev/highlight.js) )
- Optional integration with [`contented`](https://code.ivysaur.me/contented/) for file/image uploads
Written in Golang, PHP
For the 20150901 release, a desktop version is available for Windows (based on PHPDesktop).
=USAGE=
Prior to the 3.0 release, YATWiki was a PHP script instead of a standalone server.
## Usage
You can start YATWiki by running the binary. A default configuration file and database will be automatically generated if they are not found.
`Usage of ./yatwiki-server:
```
Usage of ./yatwiki-server:
-config string
Configuration file (default "config.json")
-listen string
Bind address (default "127.0.0.1:80")
`
```
=GO GET=
This package can be installed via go get: `go get code.ivysaur.me/yatwiki`
[go-get]code.ivysaur.me/yatwiki git https://git.ivysaur.me/code.ivysaur.me/yatwiki.git[/go-get]
=CHANGELOG=
## Changelog
2018-04-02 3.3.0
- Feature: Allow deleting (and un-deleting) articles
@ -76,7 +72,7 @@ This package can be installed via go get: `go get code.ivysaur.me/yatwiki`
- Fix an issue with `[html]` tags
- Fix an issue with viewing history for unknown articles
2017-07-11 3.0
2017-07-11 3.0.0
- YATWiki was rewritten in Go.
- Enhancement: Standalone binary server
- Enhancement: No longer requires cookies for error messages