Skip to content
Permalink
Browse files

Prepare docs + README for publishing

Signed-off-by: Till Kottmann <me@deletescape.ch>
  • Loading branch information
deletescape committed Nov 26, 2019
1 parent 4b8a35e commit c51758d3b4d359f96b4f22ebc88b78b12b97c2a8
Showing with 139 additions and 28 deletions.
  1. +6 −0 .github/FUNDING.yml
  2. +66 −0 README.md
  3. +50 −26 documents/about.md
  4. +16 −1 documents/changelog.md
  5. +1 −1 documents/github
@@ -0,0 +1,6 @@
# These are supported funding model platforms

github: [deletescape]
patreon: deletescape
liberapay: deletescape
custom: ['https://paypal.me/deletescape', 'https://buymeacoff.ee/deletescape']
@@ -0,0 +1,66 @@
# dogbin - the sexiest pastebin and url shortener ever!
Sharing short code samples, logs, links or markdown notes is now easier than ever!

## Basics
The easiest way to use dogbin, is from inside your browser. Type or paste your content
into the text area on the homepage (`ctrl + n`), save it (`ctrl + s`) and copy the link.
You can now share this link with whoever you want.

If you want to create a short url from a link, simply paste the link in the text field.
You can now copy the resulting link and it will automatically redirect everyone.

### Editing
You can edit your documents by clicking the edit button (or `ctrl + e`).

When you create your first document we will automatically create an (anonymous) account
for you, so you will be able to edit your documents for as long as you keep our cookie.
If you want a more permanent way to keep your pastes and edit them from multiple devices
you can [create an account](/register). Pastes which you created before signing up will
be automatically transferred to your account.

### Custom URL
If you want to use a custom slug (the part after `del.dog/`) you can do so by entering
your desired url in the `Custom URL` field.

### Document lifetime
There is no explicit expiration time for documents on dogbin. Documents may however be
removed at any time without notice.

## Using from the command line
You can easily use dogbin from the command line with our official command line client [inu](/inu).

## API usage
The basic dogbin api is an extension of the hastebin API. Extensions include the ability to
specify a custom slug, and the `X-Api-Key` header.

A more complete documentation and a full rest API (allowing for custom frontends) will be
available soon.

## Privacy
dogbin is a product which actually values your privacy. We are almost fully compliant with
the [EFF DNT policy](https://www.eff.org/dnt-policy) (our goal is to be fully compliant by January 2020). We only use cookies for authentication
and (apart from editing) all website features should be usable with cookies disabled.

Please note that **all documents** are currently indexable by search engines.

Analytics are only collected when allowed by the useragent and our analytics platform
([Simple Analytics](https://simpleanalytics.io)) uses no cookies and guarantees full privacy.
All our analytics are publicly available [here](/analytics).

> You can get 1 month of Simple Analytics for free using [my referral link](https://referral.simpleanalytics.com/deletescape).
## Open Source
dogbin is fully open source and built on open source technology. All sources can be
found on [GitHub](/github). You can easily deploy it yourself wherever you want.

## News and Updates

You can join our [Telegram Channel](https://t.me/dogbin) to get updates on maintenance and new features.

## Donations
I'm running dogbin in my free time, and unfortunately servers aren't free. The traffic
and required storage is continuously increasing (and thus also server cost). You can financially
support me via [GitHub Sponsors](https://github.com/sponsors/deletescape), [Liberapay](https://liberapay.com/deletescape) or [PayPal](https://paypal.me/deletescape).

## Contact
You can contact deletescape [here](https://deletescape.ch/contact).
@@ -2,46 +2,70 @@
title: dogbin - About
description: the sexiest pastebin and url shortener ever!
---
# dogbin - the sexiest pastebin and url shortener ever! Woof!
# dogbin - the sexiest pastebin and url shortener ever!
Sharing short code samples, logs, links or markdown notes is now easier than ever!

Sharing code and logs is cool and all, but it should be *easy*! That's where a pastebin
like dogbin comes into play!
## Basics
The easiest way to use dogbin, is from inside your browser. Type or paste your content
into the text area on the homepage (`ctrl + n`), save it (`ctrl + s`) and copy the link.
You can now share this link with whoever you want.

## Basic Usage
If you want to create a short url from a link, simply paste the link in the text field.
You can now copy the resulting link and it will automatically redirect everyone.

Type what you want me to see, click the "Save" button, and then copy the URL. Send that
URL to someone and they'll see what you see.
### Editing
You can edit your documents by clicking the edit button (or `ctrl + e`).

To make a new entry, click the "New" button (or type 'control + n')
When you create your first document we will automatically create an (anonymous) account
for you, so you will be able to edit your documents for as long as you keep our cookie.
If you want a more permanent way to keep your pastes and edit them from multiple devices
you can [create an account](/register). Pastes which you created before signing up will
be automatically transferred to your account.

### URL shortening
### Custom URL
If you want to use a custom slug (the part after `del.dog/`) you can do so by entering
your desired url in the `Custom URL` field.

To shorten an URL to a fancy, short del.dog URL, just enter the URL, click on the "Save"
button and then copy the URL. Any future calls to that URL will redirect to what you entered
earlier.
### Document lifetime
There is no explicit expiration time for documents on dogbin. Documents may however be
removed at any time without notice.

## Duration
## Using from the command line
You can easily use dogbin from the command line with our official command line client [inu](/inu).

Pastes currently have no expiration time, but they may be removed at any time
without notice.
## API usage
The basic dogbin api is an extension of the hastebin API. Extensions include the ability to
specify a custom slug, and the `X-Api-Key` header.

A more complete documentation and a full rest API (allowing for custom frontends) will be
available soon.

## Privacy
dogbin is a product which actually values your privacy. We are almost fully compliant with
the [EFF DNT policy](https://www.eff.org/dnt-policy) (our goal is to be fully compliant by January 2020). We only use cookies
for authentication and (apart from editing) all website features should be usable with
cookies disabled.

There should be no great expectation of privacy. Post things at your own risk.
Not responsible for any loss of data or removed pastes. Posts are possibly indexed
by search engines.
Please note that **all documents** are currently indexable by search engines.

## Open Source
Analytics are only collected when allowed by the useragent and our analytics platform
([Simple Analytics](https://simpleanalytics.io)) uses no cookies and guarantees full privacy.
All our analytics are publicly available [here](/analytics).

dogbin can easily be installed behind your proxy, and it's all [open source](https://del.dog/github)!
*You can get 1 month of Simple Analytics for free using [my referral link](https://referral.simpleanalytics.com/deletescape).*

## Open Source
dogbin is fully open source and built on open source technology. All sources can be
found on [GitHub](/github). You can easily deploy it yourself wherever you want.

## News / Updates
## News and Updates

To stay up to date about updates, downtimes and other news related to dogbin
join the [@dogbin](https://t.me/dogbin) channel on Telegram or follow
[@deldotdog](https://twitter.com/deldotdog) on Twitter!
You can join our [Telegram Channel](https://t.me/dogbin) to get updates on maintenance and new features.

## Analytics
## Donations
I'm running dogbin in my free time, and unfortunately servers aren't free. The traffic
and required storage is continuously increasing (and thus also server cost). You can financially
support me via [GitHub Sponsors](https://github.com/sponsors/deletescape), [Liberapay](https://liberapay.com/deletescape) or [PayPal](https://paypal.me/deletescape).

dogbin collects visitor stats via [Simple Analytics](https://simpleanalytics.io) ([my referral link for 1 month off](https://referral.simpleanalytics.com/deletescape)) for maximum privacy.
These stats are actually public and can be viewed [here](https://del.dog/analytics).
## Contact
You can contact deletescape [here](https://deletescape.ch/contact).
@@ -1 +1,16 @@
# All new everything
# All new everything
* Completely rewrite dogbin in Kotlin
* Run code highlighting on the server (far better client performance)
* We use a different (more accurate) highlighter now (chroma)
* Android logcats will now be highlighted using a custom syntax definition
* Create proper UI for the user system
* Add api keys to allow creating/modifying documents from anywhere (not properly documented yet)
* Use self-hosted iframely for embeds in markdown
* Properly leverage caching server side
* Improve overall performance
* Move away from MongoDB (we use [xodus](https://github.com/jetbrains/xodus) now)
* Display stats collected via Simple Analytics + collect url stats there
* Some small improvements to the frontend
* Hovering over the creator will now show the creation time
* Clicking on the view count will now redirect to the public stats on SA
* An all new syntax theme!
@@ -1 +1 @@
https://github.com/dogbin/server
https://github.com/dogbin/dogbin

0 comments on commit c51758d

Please sign in to comment.
You can’t perform that action at this time.