From 6d4809168d712f5bff93f3684cea00a0252029f5 Mon Sep 17 00:00:00 2001 From: Juergen Hasch Date: Sat, 10 May 2014 23:53:27 +0200 Subject: [PATCH] Update readme file --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 894055c..8fedf77 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,24 @@ IPython notebook extensions =========================== -The IPython notebook allows extending the html frontend functionality (i.e. what you do in the Browser) using extensions written in Javascript. This repository contains a collection of such extensions. The maturity of the provided extensions may vary, please create an issue if you encounter any problems. +This repository contains a collection of extensions that add functionality to the IPython notebook. +These extensions are mostly written in Javascript and will be loaded locally in your Browser. +The maturity of the provided extensions may vary, please create an issue if you encounter any problems. + +Overview +=========================== +The repository is organized in different categories: + +| Name | Description | +|------------|-------------| +| usability | Additional functionality for the notebook | +| publishing | Getting your notebooks out into the wild | +| styling | Styling schemes for different looks of the notebook | +| slidemode | Slideshow creation for usw with reveal.js | +| testing | Extensions in a early stage | + + Documentation ============= The extensions are documented in the Wiki. Please take a look [here](https://github.com/ipython-contrib/IPython-notebook-extensions/wiki) -