From 04a8c57f3db6e83cc0c06e2906e186a304cb4f74 Mon Sep 17 00:00:00 2001 From: Allan Jardine Date: Wed, 16 Oct 2013 14:24:42 +0100 Subject: [PATCH 1/3] Add contributing file and update readme to be a markdown file with updated content. --- Contributing.md | 9 ++++++++ Readme.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 69 insertions(+) create mode 100644 Contributing.md create mode 100644 Readme.md diff --git a/Contributing.md b/Contributing.md new file mode 100644 index 00000000..b3894ce2 --- /dev/null +++ b/Contributing.md @@ -0,0 +1,9 @@ +# Contributing + +If you are thinking of contributing code to DataTables, first of all, thank you! All fixes, patches and enhancements to DataTables are very warmly welcomed. In order to keep thing manageable, there are a number of guidelines that should be followed in order to ensure that your modification is included in DataTables as quickly as possible: + +1. Make contributions in the DataTables/DataTablesSrc repo. Changes to the built files in the built repo (DataTables/DataTables) will not be accepted since they would be overwritten by the next build! + +2. Follow the style of the code in the existing files. DataTables doesn't have a coding standards document, but simple common sense of following the same style as in the existing files is ideal. For example use tabs not spaces (as you will see all source files use tabs). + +3. Link to a test page showing the bug you are fixing or the feature you are adding. This allows to me to quickly identify what is being changed and why. Don't worry about being verbose in pull requests - its much better to know exactly what is changing and why! diff --git a/Readme.md b/Readme.md new file mode 100644 index 00000000..a4330d6d --- /dev/null +++ b/Readme.md @@ -0,0 +1,60 @@ +# DataTables plug-in for jQuery + +DataTables is a table enhancing plug-in for the [jQuery](//jquery.com) Javascript library, adding sorting, paging and filtering abilities to plain HTML tables with minimal effort. The stated goal of DataTables is: + +> To enhance the accessibility of data in HTML tables. + +To met this goal, DataTables is developed with two distinct groups of users in mind: + +* You the developers using DataTables. For developers DataTables provides a wide array of options for how data should be obtained, displayed and acted upon, along with an extensive API for accessing and manipulating the table. + +* End users. For those using the interface DataTables presents, actions to get the most from the information contained in tables, such as sorting and filtering, along with paging and scrolling of the data in table, are easy to use, intuitive and fast. + + +## Installation + +In most cases, to use DataTables all you need to do is include jQuery, the DataTables Javascript and DataTables CSS files in your HTML page: + +```html + + + + +``` + + +## Usage + +In its simplest case, DataTables can be initialised with a single line of Javascript: + +```js +$('table').dataTable(); +``` + +where the jQuery selector is used to obtain a reference to the table you want to enhance with DataTables. Optional configuration parameters can be passed in to DataTables to have it perform certain actions by using a configuration object as the parameter passed in to the DataTables constructor. For example: + +```js +$('table').dataTable( { + paginate: false, + scrollY: 300 +} ); +``` + +will disable paging and enable scrolling. + +A full list of the options available for DataTables are available in the [documentation](//datatables.net). + + +## Documentation + +Full documentation of the DataTables options, API and pug-in interface are available on the [DataTables web-site](//datatables.net). The site also contains information on the wide variety of plug-ins that are available for DataTables, which can be used to enhance and customise your table even further. + + +## Support + +Support for DataTables is available through the [DataTables forums](//datatables.net/forums) and [commercial support options](//datatables.net/support) are available. + + +## License + +DataTables is release under the [MIT license](//datatables.net/license). You are free to use, modify and distribute this software, but all copyright information must remain. From 8c1aca83c670cbfbaf677981c9b91e728a0fce6d Mon Sep 17 00:00:00 2001 From: Allan Jardine Date: Wed, 16 Oct 2013 14:27:44 +0100 Subject: [PATCH 2/3] Remove old Readme file, now replaced with md file with updated content --- Readme.txt | 11 ----------- 1 file changed, 11 deletions(-) delete mode 100644 Readme.txt diff --git a/Readme.txt b/Readme.txt deleted file mode 100644 index 96a47cbd..00000000 --- a/Readme.txt +++ /dev/null @@ -1,11 +0,0 @@ -This DataTables plugin (v1.9.x) for jQuery was developed out of the desire to allow highly configurable access to HTML tables with advanced access features. - -For detailed installation, usage and API instructions, please refer to the DataTables web-pages: http://www.datatables.net - -Questions, feature requests and bug reports (etc) can all be asked on the DataTables forums: http://www.datatables.net/forums/ - -The DataTables source can be found in the media/js/ directory of this archive. - -DataTables is released with dual licensing, using the GPL v2 (license-gpl2.txt) and an BSD style license (license-bsd.txt). You may select which of the two licenses you wish to use DataTables under. Please see the corresponding license file for details of these licenses. You are free to use, modify and distribute this software, but all copyright information must remain. - -If you discover any bugs in DataTables, have any suggestions for improvements or even if you just like using it, please free to get in touch with me: www.datatables.net/contact \ No newline at end of file From 09e58487cb570a25f582fb645790b792663c7ccd Mon Sep 17 00:00:00 2001 From: Allan Jardine Date: Wed, 16 Oct 2013 14:29:53 +0100 Subject: [PATCH 3/3] Dev: Fix typo in readme file --- Readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Readme.md b/Readme.md index a4330d6d..479a1fa7 100644 --- a/Readme.md +++ b/Readme.md @@ -4,7 +4,7 @@ DataTables is a table enhancing plug-in for the [jQuery](//jquery.com) Javascrip > To enhance the accessibility of data in HTML tables. -To met this goal, DataTables is developed with two distinct groups of users in mind: +To meet this goal, DataTables is developed with two distinct groups of users in mind: * You the developers using DataTables. For developers DataTables provides a wide array of options for how data should be obtained, displayed and acted upon, along with an extensive API for accessing and manipulating the table.