mirror of
https://github.com/schollz/cowyo.git
synced 2023-08-10 21:13:00 +03:00
Updated README
This commit is contained in:
parent
1c7524cc45
commit
405bc46958
56
README.md
56
README.md
@ -1,7 +1,57 @@
|
|||||||
# cowyo2
|
|
||||||
|
|
||||||
Make with
|
<p align="center">
|
||||||
|
<img
|
||||||
|
src="/static/img/logo.png"
|
||||||
|
width="260" height="80" border="0" alt="linkcrawler">
|
||||||
|
<br>
|
||||||
|
<img src="https://img.shields.io/badge/version-2.0.0-brightgreen.svg" alt="Version">
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p align="center">A simple and powerful notepad supporting listifying, encryption, self-destructing messages, and versioning</a></p>
|
||||||
|
|
||||||
|
This is a self-contained notepad webserver that makes sharing easy and _fast_. The most important feature here is _simplicity_. There are many other features as well including versioning, page locking, self-destructing messages, encryption, syntax highlighting, content-delivery, and listifying.
|
||||||
|
|
||||||
|
Getting Started
|
||||||
|
===============
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
If you have go
|
||||||
|
|
||||||
```
|
```
|
||||||
go-bindata static/... templates/... && go build && ./cowyo2 serve
|
go get github.com/schollz/cowyo
|
||||||
```
|
```
|
||||||
|
|
||||||
|
or just download from the [latest releases](https://github.com/schollz/cowyo/releases/latest).
|
||||||
|
|
||||||
|
## Run
|
||||||
|
|
||||||
|
To run just double click or from the command line:
|
||||||
|
|
||||||
|
```
|
||||||
|
cowyo
|
||||||
|
```
|
||||||
|
|
||||||
|
## Contact
|
||||||
|
|
||||||
|
If you'd like help or you find a bug, please submit [an issue](https://github.com/schollz/cowyo/issues). Any other comments, questions or anything at all, just [tweet me @zack_118](https://twitter.com/intent/tweet?screen_name=zack_118)
|
||||||
|
|
||||||
|
## Acknowledgements
|
||||||
|
|
||||||
|
Thanks to [tscholl2](https://github.com/tscholl2) and [sjsafranek](https://github.com/sjsafranek).
|
||||||
|
|
||||||
|
Icons made by [Freepik](http://www.freepik.com) from [www.flaticon.com](http://www.flaticon.com), licensed by [CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/ "Creative Commons BY 3.0").
|
||||||
|
|
||||||
|
File uploading from [transfer.sh](https://github.com/dutchcoders/transfer.sh/blob/98399c91dd86682077cf9542badbf1658fd9a8c1/transfersh-server/handlers.go#L293-L369), licensed by [MIT license](https://github.com/dutchcoders/transfer.sh/blob/40c9bf7675fb84e78d9a011052b9d0900ec7dde1/LICENSE).
|
||||||
|
|
||||||
|
# License
|
||||||
|
|
||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2016 Zack
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
Loading…
Reference in New Issue
Block a user