plone.app.modernizr/master: Added improvements about README file

Repository: plone.app.modernizr
Branch: refs/heads/master
Date: 2018-07-22T12:39:03-04:00
Author: Leonardo J. Caballero G (macagua) <[email protected]>
Commit: https://github.com/plone/plone.app.modernizr/commit/8531bdee0a4a3331e8e05a2fbbd52114de3aabb6

Added improvements about README file

Files changed:
M CHANGES.txt
M README.rst

b'diff --git a/CHANGES.txt b/CHANGES.txt\nindex 1873033..092592c 100644\n--- a/CHANGES.txt\n+++ b/CHANGES.txt\n@@ -3,6 +3,7 @@ Changelog\n \n 1.0dev (unreleased)\n -------------------\n+- Added improvements about README file [macagua]\n - Changed the package documentation files [macagua]\n - Update MANIFEST.in [mamico]\n - Initial release\ndiff --git a/README.rst b/README.rst\nindex 703416c..53f450f 100644\n--- a/README.rst\n+++ b/README.rst\n@@ -1,14 +1,20 @@\n+===================\n+plone.app.modernizr\n+===================\n+\n+\n Introduction\n ============\n \n-This addon register Modernizr_ into Plone\'s resource registry\n+``plone.app.modernizr`` package provides register `Modernizr`_ into Plone\'s resource registry\n \n version: 2.6.2 (dev)\n \n-It provides a way to configure modern
 izr using the portal_registry.\n+It provides a way to configure modernizr using the ``portal_registry`` tool.\n+\n \n About Modernizr\n-===============\n+---------------\n \n Modernizr is an open-source JavaScript library that helps you build the next \n generation of HTML5 and CSS3-powered websites.\n@@ -23,32 +29,90 @@ If not, the class name will be "no-cssgradients". This allows for simple\n if-conditionals in your CSS, giving you fine control over the look & feel of\n your website.\n \n-.. _modernizr: http://www.modernizr.com\n+\n+Requirements\n+============\n+\n+- From the Plone 4.1.x To the Plone 4.3 latest version (https://plone.org/download)\n+- The ``plone.resource`` and ``Products.ResourceRegistries`` packages (*You will need enable it to use these packages*)\n+\n+\n+Features\n
 +========\n+\n+- Provides a browser page ``@@plone.app.modernizr.download`` for download the *Modernizr* js resource.\n+- Provides the *Modernizr* 2.6.2 version resources.\n+\n+\n+Installation\n+============\n+\n+\n+Buildout\n+--------\n+\n+If you are a developer, you might enjoy installing it via buildout.\n+\n+For install ``plone.app.modernizr`` package add it to your ``buildout`` section\'s \n+*eggs* parameter e.g.: ::\n+\n+   [buildout]\n+    ...\n+    eggs =\n+        ...\n+        plone.app.modernizr\n+\n+\n+and then running ``bin/buildout``.\n+\n+Or, you can add it as a dependency on your own product ``setup.py`` file: ::\n+\n+    install_requires=[\n+        ...\n+        \'plone.app.modernizr\',\n+    ],\n+\n+\n+Enabling\n+--------\n+\n+Select and enable the ``plone.app.moderniz
 r`` package from the ``Add-ons``\n+control panel. That\'s it!\n+\n+\n+Usage\n+=====\n+\n \n How to build or update a new optimized modernizr\n-================================================\n+------------------------------------------------\n \n-You just have to hit the view /@@plone.app.modernizr.download, you will be\n+You just have to hit the view ``/@@plone.app.modernizr.download``, you will be\n redirect to the download page of modernizr.com with the needed plugins.\n \n So hit the download button to get the modernizr file.\n \n Now to store the js you have two options:\n \n+\n TTW: using plone.resource\n--------------------------\n+^^^^^^^^^^^^^^^^^^^^^^^^^\n+\n+* Go to ``/portal_resources/manage_main``\n+* Add a folder called ``resource``\n+* Add a file and upload your modernizr
  js with the id ``modernizr.custom.js`` under\n+  the folder called ``theme/plone.app.modernizr/modernizr.custom.js`` \n+* Then go to ``/portal_registry`` and configure modernizr resource name to \n+  ``++theme++plone.app.modernizr/modernizr.custom.js``\n \n-* Go to /portal_resources/manage_main\n-* Add a folder called resource\n-* Add a file and upload your modernizr js with the id modernizr.custom.js under\n-  theme/plone.app.modernizr/modernizr.custom.js\n-* Then go to /portal_registry and configure modernizr resource name to ++theme++plone.app.modernizr/modernizr.custom.js\n \n FS: using your own addon / policy\n----------------------------------\n+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n+\n+* Add you downloaded file to your *policy* addon in a ``resource`` directory\n+* Add a ``registry.
 xml`` file to configure modernizr:\n \n-* Add you downloaded file to your policy in a resource directory\n-* Add a registry.xml file to configure modernizr::\n+::\n \n   <registry>\n     <records interface="plone.app.modernizr.resources.IModernizr">\n@@ -78,3 +142,35 @@ FS: using your own addon / policy\n \n This way future maintainer or integrator will be able to provide an updated\n version of modernizr without forgetting tests.\n+\n+\n+Contribute\n+==========\n+\n+- Issue Tracker: https://github.com/plone/plone.app.modernizr/issues\n+- Source Code: https://github.com/plone/plone.app.modernizr\n+\n+\n+License\n+=======\n+\n+The project is licensed under the GPLv2.\n+\n+\n+Credits\n+-------\n+\n+- Plone Foundation.\n+\n+\n+Amazing contributions\n+---------------------\n+\n+- JeanMichel 
 FRANCOIS (toutpt at gmail dot com).\n+- Jens W. Klein (jk at kleinundpartner dot at).\n+- Mauro Amico (mauro.amico at gmail dot com).\n+- Leonardo J. Caballero G. aka macagua (leonardocaballero at gmail dot com).\n+\n+You can find an updated list of package contributors on https://github.com/plone/plone.app.modernizr/contributors\n+\n+.. _`Modernizr`: http://www.modernizr.com/\n'



------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot