diff --git a/README.md b/README.md index 47ee2c7..a82d8e3 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,28 @@ -# fedmsg-perceval-plugin - -A fedmsg plugin for perceval - ---- - ## Welcome GSoC and Outreachy applicants! This repo is brand new and it's meant to be :) --- -### Beginner tasks +## Beginner tasks -##### Research about fedmsg and Perceval. +#### Research about fedmsg and Perceval. + +fedmsg is extensively documented and is used in a lot of Fedora applications. You can read the documentation on [Read the Docs](http://fedmsg.readthedocs.io/) and review applications that are found in the [fedora-infra GitHub repository](https://github.com/fedora-infra). + -- fedmsg is extensively documented and is used in a lot of Fedora applications. You can read the documentation on [Read the Docs](http://fedmsg.readthedocs.io/) and review applications that are found in the [fedora-infra GitHub repository](https://github.com/fedora-infra). - #### Write a minimal fedmsg app which can trigger an event (can be anything like tweeting, sending an IRC message, or anything crazy {Remember, sky is the limit!}) using fedmsg. -- To get started with this task, please go through Ralph Bean's slides on [How to build your own fedmsg applications](http://threebean.org/presentations/fedmsg-flock14/#/step-1). It is a good starting point if you think fedmsg documentation doesn't answer your questions. + To get started with this task, please go through Ralph Bean's slides on [How to build your own fedmsg applications](http://threebean.org/presentations/fedmsg-flock14/#/step-1). It is a good starting point if you think fedmsg documentation doesn't answer your questions. - -##### Write a basic Perceval plugin which pulls data from any REST API you like (yep, ANY!) -- Perceval has a lot of backends defined already. If you like some real-time examples, head over to the [Perceval backend code](https://github.com/chaoss/grimoirelab-perceval/tree/master/perceval/backends/core) and review all the Python files available there. For instructions on how to use Perceval to gather data, [read the training manual](https://www.gitbook.com/book/grimoirelab/tutorial/details) designed by Grimoirelab developers :) + +#### Write a basic Perceval plugin which pulls data from any REST API you like (yep, ANY!) + +Perceval has a lot of backends defined already. If you like some real-time examples, head over to the [Perceval backend code](https://github.com/chaoss/grimoirelab-perceval/tree/master/perceval/backends/core) and review all the Python files available there. For instructions on how to use Perceval to gather data, [read the training manual](https://www.gitbook.com/book/grimoirelab/tutorial/details) designed by Grimoirelab developers :) + ### Resources & Quick Reference