Permalink
Browse files

Better readme, add logo to home page.

  • Loading branch information...
1 parent fa5bb03 commit e2719420b0201bc72ee4634921041dbe1eb46511 @aaronpk committed Jan 28, 2013
Showing with 40 additions and 5 deletions.
  1. +37 −4 README.md
  2. BIN public/img/PingbackLogo512.png
  3. +3 −1 views/index.erb
View
@@ -1,5 +1,4 @@
-Pingbacks
-=========
+# Pingbacks
This project is an implementation of the Pingback protocol. It allows the pingback service to be run separately from the blogging software or website environment, making it easier to manage and integrate with other services.
@@ -11,8 +10,42 @@ The Pingback protocol also supports sending the URL in the headers,
X-Pingback: http://pingback.me/username/xmlrpc
-About the Pingback Protocol
----------------------------
+
+## Features
+
+* Accept pingbacks for any site by adding a simple html tag: `<link rel="pingback" href="http://pingback.me/username/xmlrpc" />`
+* API to get a list of sites linking to your pages
+
+
+### Future Features
+
+* Provide an API method for sending outgoing pingbacks from your own site to pages you link to
+
+
+## API
+
+This service provides an API for returning a list of pages that have linked to a given page. For example:
+
+```
+GET http://pingback.me/api/links?target=http://pingback.me/
+
+{
+ "links": [
+ {
+ "href": "http://indiewebcamp.com/pingback",
+ "verified": true,
+ "verified_date": "2013-01-27T19:05:37-08:00"
+ }
+ ]
+}
+```
+
+## IRC Notifications
+
+If you are running an instance of [ZenIRCBot](https://github.com/wraithan/zenircbot), you can use it to receive IRC notifications when a new pingback is received. You'll need to be running the [web-proxy](https://github.com/aaronpk/zenircbot/blob/master/services/web-proxy.js) service, and then you can configure the URL and channel the message should be delivered to.
+
+
+## About the Pingback Protocol
The pingback system is a way for a blog to be automatically notified when other Web sites link to it. It is entirely transparent to the linking author, requiring no user intervention to work, and operates on principles of automatic discovery of everything that it needs to know.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
@@ -4,9 +4,11 @@
<br /><br />
<div class="hero-unit">
+ <img src="/img/PingbackLogo512.png" width="200px" class="pull-left" style="background-color: #eee" />
+
<h1>Pingback.me</h1>
<p>
- Pingback.me is a pingback API created to easily support pingbacks on any web page. Currently it is not open for signups, but you can <a href="https://github.com/aaronpk/Pingback">download the source code</a> and run it on your own server.
+ Pingback.me is a hosted pingback service created to easily support pingbacks on any web page. Currently it is not open for signups, but you can <a href="https://github.com/aaronpk/Pingback">download the source code</a> and run it on your own server.
</p>
<p>
You might also be interested in reading about this project on the <a href="http://indiewebcamp.com/pingback.me">IndieWebCamp wiki</a>.

0 comments on commit e271942

Please sign in to comment.