diff --git a/README.md b/README.md index 4bfa74d..4ddbddf 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ db8 Site Dev (pkg_db8sitedev) =============== -A Joomla Site Development Tool (Component + Module) to **improve your workflow** with **Joomla website development**. -Create a Checklist for your own workflow and import it on all the websites that you'll develop. +A Joomla Site Development Tool to **improve your workflow** with **Joomla website development**. +- Create a Checklist for your own workflow +- Export your Checklist and import it in all the websites that you develop. +- Keep a full overview of everything that you have done and anything that still needs to be done. ### Features - Easily manage your own Checklist of everything you have to do before a website can be put online @@ -11,47 +13,46 @@ Create a Checklist for your own workflow and import it on all the websites that - Download and import a default Site Checklist with items related to Joomla website development - Have a full overview of everything that has been done and have to be done - Easily check or uncheck items to update the status of an item -- Add a note with details to each Checklist item +- Add notes with details to each Checklist item - Add hyperlinks to your notes to create short cuts to specific pages in your Joomla admin or external websites ### Getting started - [Download db8 Site Dev](http://www.db8.nl/en/download/components-download/db8-site-dev) - Install the package (Component + Module) in the Extension Manager -- The Component will be installed with one default Category "db8 Site Dev" and some default Checklist items related to the extension -- The About page has an option to import a Checklist - -### Benefits -- Improve your website development workflow -- Have a full overview of all items that have been done or still should be taken care of +- The Component will be installed with one default Checklist +- Look at how to create a Checklist via Categories + Check Items +- Look at how the Checklist works and the result in the overview on the Dashboard +- The About page has an option to export/import a Checklist +- In case you find a bugs in this software, please create an issue at [Github.com](https://github.com/pe7er/db8sitedev/issues) +- If you find this extension useful, please consider leaving a positive review at the [Joomla Extension Directory (JED)](http://extensions.joomla.org/extensions/extension/db8-site-dev) ### Background -With my company [db8.nl](http://www.db8.nl) I support companies with Joomla websites. +Since 2005 I support with my company [db8.nl](http://www.db8.nl) other companies with Joomla websites. When developing websites for customers I always have to do the same things to configure and optimize the website before putting it live. The awesome **[Live Checklist](https://github.com/renekreijveld/livechecklist)** created by -**[Rene Kreijveld](http://www.renekreijveld.nl/)** has proven to be a great tool -to keep track of everything that you have to do. It's a list of things you have to do to configure and optimize your Joomla website. +**[Rene Kreijveld](http://www.renekreijveld.nl/)** has proven to be a great tool to keep track of everything that you have to do. +It's a list of things you have to do to configure and optimize your Joomla website. -However, it's a list that you can use offline next to your computer. But what if such a list would be inside the website you were developing? +However, the list is an offline one that you can use next to your computer. What if such a list would be inside the website you were developing? I decided to develop this extension to have such a checklist tool within the website that is under development. -Webdevelopers can add their own checklist or Generate a default Live Checklist. +Website developers can add their own checklist or Generate a default Live Checklist. ### Download You can download an installation package from [Download page at db8.nl](http://www.db8.nl/en/download/components-download/db8-site-dev) or get the most recent release from [github.com/pe7er/db8sitedev/releases](https://github.com/pe7er/db8sitedev/releases) +This package consists of a Component and a Module: -If you find this extension useful, please consider leaving a review at the [Joomla Extension Directory (JED)](http://extensions.joomla.org/extensions/extension/db8-site-dev) - -This extension consists of a Component and a Module: +**Component** -#### Component -With the Admin Component a webdeveloper can easily create a checklist of all things that have to be done before the site can be put live. +With the Admin Component a website developer can easily create a checklist of all things that have to be done before the site can be put live. The component has an option to import or export your own checklists. -#### Module -The Admin Module is published on the Control Panel of your /administrator back-end so that you can easily keep track of everything that still has to be done. +**Module** + +The Admin Module is published on the Control Panel of your /administrator/ back-end so that you can easily keep track of everything that still has to be done. The UNchecked and Checked counters and Category name can all be clicked and will navigate you to the Checklist, filtered on what you clicked. -### Credits & Contributions +### Credits and Contributions I would like to thank the following fellow Joomla community members that inspired or helped me with the development of this extension: Roland Dalmulder, Rene Kreijveld, Jisse Reitsma.