diff --git a/README.md b/README.md index 02965c8..d21e777 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,23 @@ out there, but they are either: * are not flexible enough while keeping the configuration simple * are not friendly to your own code * are not friendly to designers +* have unnecessary dependencies to monolithic libraries * more annoying things That's why we have started Chartist.js and our goal is to solve all of the above issues. +## What is it made for? + +Chartist's goal is to provide a simple, lightweight and non-intrusive library to responsive craft charts on your website. +It's important to understand that one of the main intentions of Chartist.js is to rely on standards rather than providing +a own solution to the problem which is is already solved by the standard. We need to leverage the power of the browsers +today and say good bye to the idea of solving all problems ourselves. + +Chartist works with inline-SVG and therefore leverages the power of the DOM to provide parts of its functionality. This +also means that Chartist is not providing it's own event handling, labels, behaviors and anything else that can just be +done with plain HTML, JavaScript and CSS. The single and only responsibility of Chartist is to help you drawing "Simple +responsive Charts" using inline-SVG in the DOM, CSS to style and JavaScript to provide an API for configuring your charts. + ## Example site You can visit this Site http://gionkunz.github.io/chartist-js/ which is in fact a build of the current project. @@ -32,9 +45,10 @@ to the masses. 1. Jasmine Tests! 2. Documentation: JSDoc, Getting started documentation and landing page -3. Better interfaces to the library (i.e. jQuery with data-* attributes for configuration), Angular.js directive etc. -4. Richer SASS / CSS framework -5. Other charts types (spider etc.) +3. Better accessibility using ARIA and other optimizations +4. Better interfaces to the library (i.e. jQuery with data-* attributes for configuration), Angular.js directive etc. +5. Richer SASS / CSS framework +6. Other charts types (spider etc.) ## Contribution diff --git a/source/site/code-snippets/simple-start.html b/source/site/code-snippets/simple-start.html index 5b2c0f7..7f32809 100644 --- a/source/site/code-snippets/simple-start.html +++ b/source/site/code-snippets/simple-start.html @@ -2,7 +2,6 @@
- \ No newline at end of file