[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/webpaste 8d5e884 200/298: Added skeleton of documentation
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/webpaste 8d5e884 200/298: Added skeleton of documentation for creation of custom providers. |
Date: |
Thu, 9 Dec 2021 19:00:14 -0500 (EST) |
branch: elpa/webpaste
commit 8d5e884eca71df97735e7eab0270a01b746b2a6d
Author: Elis Axelsson <elis.axelsson@gmail.com>
Commit: Elis Axelsson <elis.axelsson@gmail.com>
Added skeleton of documentation for creation of custom providers.
This fixes #21.
---
README.org | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
diff --git a/README.org b/README.org
index 45f160e..56dfe7d 100644
--- a/README.org
+++ b/README.org
@@ -117,6 +117,26 @@ can have several hooks as well if you want it to do
several custom things.
(lambda (url) (browse-url-generic url)))
#+end_src
+*** Custom providers
+The example of one of the simplest providers possible to write:
+#+begin_src emacs-lisp
+ (require 'webpaste)
+ (add-to-list
+ 'webpaste-providers-alist
+ '("example.com"
+ :uri "https://example.com/"
+ :post-field "content"
+ :success-lambda webpaste-providers-success-location-header))
+#+end_src
+
+Options available are the options used in webpaste--provider. These docs are
+available within emacs documentation. To read this you need to require
+webpaste first and then just read the documentation by running this:
+#+begin_src emacs-lisp
+ (require 'webpaste)
+ (describe-function 'webpaste--provider)
+#+end_src
+
** TODO Providers to implement [7/10]
- [X] ptpb.pw
- [X] ix.io
- [nongnu] elpa/webpaste d37a904 160/298: Fix POST bug for several providers, (continued)
- [nongnu] elpa/webpaste d37a904 160/298: Fix POST bug for several providers, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 30e78d6 164/298: Refactored the error callbacks, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste d27e571 182/298: Added integration tests for paste.pound-python.org, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 76d4ddb 162/298: Update test to test the right function, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 4937b30 177/298: Change integration test to contain a link to webpaste in the pasted message, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 6b0043b 181/298: Added integration tests for dpaste.de, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 505ffb3 189/298: Switched all webpaste/whatever to webpaste-watever to comply with elisp guidelines, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 0546284 176/298: Added types to some defcustom missing it, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 321e6a4 191/298: Added more details for contributing, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 26b4d21 192/298: Added test of appending mode name to post data, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 8d5e884 200/298: Added skeleton of documentation for creation of custom providers.,
ELPA Syncer <=
- [nongnu] elpa/webpaste 655a364 205/298: Remove local variables since it became easier to get the providers, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste d6967bd 217/298: Check emacs version after emacs install, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 2da60b8 223/298: Bump version for new release, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 1925521 228/298: Add emacs 26.1 to tests, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 9c5e921 234/298: WP-25: Add README for raw pastes, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 3d639f1 256/298: Merge branch 'fix-undercover', ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 51b20d9 235/298: Merge branch 'WP-25-raw-pastes', ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 22f64b7 255/298: undercover: Fix up undercover reporting, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste a8b682a 239/298: Add toml lang to ptpb.pw default, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 2c399a0 243/298: Tests: Add unit tests for shebangs to override major-mode, ELPA Syncer, 2021/12/09