Permalink
Browse files

update README

  • Loading branch information...
areski committed Apr 8, 2013
1 parent a91b02d commit 85284d6a5baf65ea4b617f4734b5418207497154
Showing with 39 additions and 2 deletions.
  1. +2 −2 MIT-LICENSE.txt
  2. +37 −0 README.rst
View
@@ -1,8 +1,8 @@
The MIT License (MIT)
-Python-Acapela
+Python-nvd3
-Copyright (c) 2012 Arezqui Belaid <areski@gmail.com> and other contributors
+Copyright (c) 2013 Arezqui Belaid <areski@gmail.com> and other contributors
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
View
@@ -21,3 +21,40 @@ Or if you don't have `pip`::
$ sudo easy_install python-nvd3
+
+Usage
+-----
+
+After installation use python-nvd3 as follow ::
+
+ from nvd3 import pieChart
+
+ chart = pieChart(name="pieChart", height=450, width=450)
+ xdata = ["Orange", "Banana", "Pear", "Kiwi", "Apple", "Strawberry", "Pineapple"]
+ ydata = [1, 2, 3, 4, 5, 3, 4]
+
+ chart.add_serie(y=ydata, x=xdata)
+ chart.buildhtml()
+
+ output_file.write("\n\n<h2> pieChart Graph </h2>\n\n")
+ output_file.write(chart.html)
+
+ #close Html file
+ output_file.close()
+
+
+
+See our examples directory for more usage.
+
+
+Documentation
+-------------
+
+Documentation is available on 'Read the Docs':
+http://python-nvd3.readthedocs.org
+
+
+License
+-------
+
+Python-nvd3 is licensed under MIT, see `MIT-LICENSE.txt`.

0 comments on commit 85284d6

Please sign in to comment.