Skip to content

Commit 3c19e8f

Browse files
committed
Update README.md
1 parent d08740b commit 3c19e8f

File tree

Image for: File tree

1 file changed

Image for: 1 file changed
+52
-2
lines changed

1 file changed

Image for: 1 file changed
+52
-2
lines changed

‎README.md

Lines changed: 52 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,52 @@
1-
webmention-specification
2-
========================
1+
# WebMention Specification
2+
3+
A modern alternative to [Pingback](http://www.hixie.ch/specs/pingback/pingback).
4+
5+
6+
## Protocol Flow
7+
8+
### Sender discovers Receiver Endpoint
9+
10+
```
11+
> GET /bob/post/2 HTTP/1.1
12+
> Host: bobs.host
13+
14+
15+
< HTTP/1.1 200 OK
16+
< Link: <http://bobs.host/webmention-endpoint>; rel="http://webmention.org/"
17+
< ...
18+
<
19+
< <html>
20+
< ...
21+
< <link href="http://bobs.host/webmention-endpoint" rel="http://webmention.org/" />
22+
< ...
23+
```
24+
25+
26+
27+
28+
### Sender Notifies Receiver
29+
30+
```
31+
> POST /webmention-endpoint HTTP/1.1
32+
> Host: bobs.host
33+
> Content-Type: application/x-www-url-form-encoded
34+
>
35+
> source=http://alices.host/alice/post/42&\
36+
> target=http://bobs.host/bob/post/2
37+
```
38+
39+
_Note: the "\" character is used here to indicate line wrapping in the request content and is not part of the content itself._
40+
41+
`bobs.host` should check that `target` is a valid resource belonging to it and then perform a `GET` on `source` and confirm that it actually links to `target`.
42+
43+
44+
## See also
45+
46+
* [Pingback](http://www.hixie.ch/specs/pingback/pingback)
47+
* [Trackback](http://archive.cweiske.de/trackback/trackback-1.2.html)
48+
* [RESTful Pingback](http://www.w3.org/wiki/Pingback)
49+
* [Semantic Pingback](http://aksw.org/projects/semanticpingback)
50+
51+
## Let's collaborate
52+
Feel free to [file an issue](https://github.com/converspace/webmention-specification/issues) if you have feedback/questions/suggestions.

0 commit comments

Image for: 0 commit comments
Comments
 (0)