Skip to content
Browse files

Readme clean up a bit

  • Loading branch information...
1 parent 81cf702 commit e3ecfb71f6aa67a1c6d53f59f4b438063c85ee35 @balupton balupton committed
Showing with 21 additions and 32 deletions.
  1. +21 −32 README.md
View
53 README.md
@@ -1,6 +1,6 @@
-# DocPad. Accessible web development. [![Build Status](https://secure.travis-ci.org/bevry/docpad.png?branch=master)](http://travis-ci.org/bevry/docpad)
+# DocPad. Web development streamlined. [![Build Status](https://secure.travis-ci.org/bevry/docpad.png?branch=master)](http://travis-ci.org/bevry/docpad)
-I'm DocPad, I streamline the processes of web development, and help close the gap between experts and beginners. I've helped companies big and small create [amazing powerful web sites and applications](https://github.com/bevry/docpad/wiki/Showcase) for over a year now quicker than ever before. What makes me different is that I just enhance web development in general, rather than being a new box to cram yourself into - meaing I have no limits and provide a powerful rubust infrastructure that helps you get stuff done faster while getting out of your way the entire time.
+Hi! I'm DocPad, I streamline the processes of web development, and help close the gap between experts and beginners. I've been used in production by big and small companies for over a year and a half now to create [plenty of amazing and powerful web sites and applications](https://github.com/bevry/docpad/wiki/Showcase) quicker than ever before. What makes me different is that I just enhance web development in general, rather than being a new box to cram yourself into - meaing I have no limits and provide a powerful rubust infrastructure that helps you get stuff done faster while getting out of your way the entire time.
Discover my features below, or simply skip to the installation instructions to get started with a [fully functional pre-made website](https://github.com/bevry/docpad/wiki/Skeletons) in a few minutes from reading this.
@@ -8,46 +8,35 @@ Discover my features below, or simply skip to the installation instructions to g
### Out of the box
-- Competely file based meaning there is no pesky database that needs to be installed, and you get version control with systems you're already use to like Git and SVN (You can still hook in remote data sources if you want, DocPad doesn't impose any limits on you, ever)
-- Plenty of community maintained [pre-made websites](https://github.com/bevry/docpad/wiki/Skeletons) for you to use for your next project instead of always starting from scratch
-- Write your documents in any language you wish, be it CoffeeScript to JavaScript, LESS to CSS or even Markdown or HAML to HTML via our [plentiful community maintained pugins](https://github.com/bevry/docpad/wiki/Plugins)
-- Changes to your website are automatically recompiled through our built in watch system
+- Competely file based meaning there is no pesky databases that need to be installed, and for version control you get use systems like Git and SVN which you're already use to (You can still hook in remote data sources if you want, DocPad doesn't impose any limits on you, ever)
+- Choose from plenty of community maintained [pre-made websites](https://github.com/bevry/docpad/wiki/Skeletons) to use for your next project instead of starting from scratch everytime
+- Write your documents in any language, markup, templating engine, or pre-processor you wish (we're truly agnostic thanks to your plugin system). You can even mix and match them when needed by combining their extensions in a rails like fashion (e.g. `coffee-with-some-eco.js.coffee.eco`)
+- Changes to your website are automatically recompiled through our built in watch system, saving you time
- Add meta data to the top of your files to be used by templating engines to display non-standard information such as titles and descriptions for your documents
-- Display custom listings of content with our powerful Query Engine available to your templating engines
+- Display custom listings of content with our powerful [Query Engine](https://github.com/bevry/query-engine/) available to your templating engines
- Abstract out generic headers and footers into layouts using our nested layout system
-- For simple static websites easily deploy your generated website to any web server like apache or github pages
-- For dynamic projects deploy them to servers like heroku and nodejitsu to take advantage of custom routing with express.js
-- Built-in server to save you from having to startup your own, for dynamic deployments this even supports things like clean urls and custom routes
-- Robust architecture and powerful plugin system means that you are never boxed in unlike traditional CMS systems, instead you can always [extend DocPad](https://github.com/bevry/docpad/wiki/Extending) to do what you need it to do, and you can even write and share plugins to bundle common custom functionality
+- For simple static websites easily deploy your generated website to any web server like apache or github pages. For dynamic projects deploy them to servers like [heroku](http://www.heroku.com/) or [nodejitsu](http://nodejitsu.com/) to take advantage of custom routing with [express.js](http://expressjs.com/). [Deploy guide here](https://github.com/bevry/docpad/wiki/Hosting)
+- Built-in server to save you from having to startup your own, for dynamic deployments this even supports things like clean urls, custom routes and server-side logic
+- Robust architecture and powerful plugin system means that you are never boxed in unlike traditional CMS systems, instead you can always [extend DocPad](https://github.com/bevry/docpad/wiki/Extending) to do whatever you need it to do, and you can even write to bundle common custom functionality and distribute them through the amazing node package manager [npm](http://npmjs.org/)
+- Built in support for dynamic documents (e.g. search pages, signup forms, etc.), so you can code pages that change on each request by just adding `dynamic: true` to your document's meta data (exposes the [express.js](http://expressjs.com/) `req` and `res` objects to your templating engine)
- You can use it standalone, or even easily include it within your existing systems with our [API](https://github.com/bevry/docpad/wiki/API)
### With our amazing community maintained plugins
-- Use the [Live Reload](https://github.com/bevry/docpad-extras/tree/master/plugins/livereload) plugin to automatically refresh your web browser whenever a change is made
+- Use the [Live Reload](https://github.com/bevry/docpad-extras/tree/master/plugins/livereload) plugin to automatically refresh your web browser whenever a change is made, this is amazing
- Pull in remote RSS/Atom/JSON feeds into your templating engines allowing you to display your latest twitter updates or github projects easily and effortlessly using the [Feedr Plugin](https://github.com/bevry/docpad-extras/tree/master/plugins/feedr/)
-- Support for every templating engine and pre-processor under the sun, including but not limited to CoffeeScript, CoffeeKup, ECO, HAML, Handlebars, Jade, Less, Markdown, PHP, Ruby, SASS and Stylus - [full listing here](https://github.com/bevry/docpad/wiki/Plugins)
+- Support for every templating engine and pre-processor under the sun, including but not limited to CoffeeScript, CoffeeKup, ECO, HAML, Handlebars, Jade, Less, Markdown, PHP, Ruby, SASS and Stylus - [the full listing is here](https://github.com/bevry/docpad/wiki/Plugins)
- Use the [Partials Plugin](https://github.com/bevry/docpad-extras/tree/master/plugins/partials/) to abstract common pieces of code into their own individual file that can be included as much as you want
- Syntax highlight code blocks automatically with our [Pygments Plugin](https://github.com/bevry/docpad-extras/tree/master/plugins/pygments/)
-- Get SEO friendly clean URLs with our [Clean URLs Plugin](https://github.com/bevry/docpad-extras/tree/master/plugins/cleanurls/) - dynamic deployments only
-- Lint your code automatically with our Lint Plugin - under development, coming soon
-- Concatenate and minify your JavaScript and CSS assets making pages load faster for your users with our Minify Plugin - under development, coming soon
-- Automatically translate your entire website into other languages with our Translation Plugin - under development, coming soon
-- Install common javascript libraries like jQuery, Backbone and Underscore directly from the common line - under development, coming soon
-- Add a admin interface to your website allowing you to edit, save and preview your changes on live websites then push them back to your source repository with the Admin Plugin - under development, coming soon
-- Pretty much if DocPad doesn't already do something, it is trivial to [write a plugin](https://github.com/bevry/docpad/wiki/Extending) to do it, seriously DocPad can accomplish anything, it never holds you back
-- There's also [plenty more plugins](https://github.com/bevry/docpad/wiki/Plugins) that haven't been listed here, well worth checking out!
-
-
-### Worth stating again
-
-- DocPad has been [used in production](https://github.com/bevry/docpad/wiki/Showcase) by big and small companies to create plenty of amazing web sites and applications (not just blogs) for over a year and a half now
-- DocPad is truly language agnostic, able to code your documents in any markup or pre-precessor that you like, when you need to you can even mix and match them by combining their extensions (e.g. `coffee-with-some-eco.js.coffee.eco`)
-- You can get started with DocPad started with DocPad from scratch with [a pre-made fully functional website](https://github.com/bevry/docpad/wiki/Skeletons) in a few minutes
-- DocPad is [highly extensible](https://github.com/bevry/docpad/wiki/Extending) and has a easy to use [plugin system](https://github.com/bevry/docpad/wiki/Writing-a-Plugin), allowing it to accomplish anything, really
-- Easy to extend the server with custom routes, or use DocPad as module in an even bigger system with it's powerful [API](https://github.com/bevry/docpad/wiki/API)
-- [Deploy easily](https://github.com/bevry/docpad/wiki/Hosting) to plenty of free Node.js hosting providers, or even just deploy it to plenty of free static file servers like GitHub Pages and more
-- Built in support for dynamic documents (e.g. search pages, signup forms, etc.), so you can code pages that change on each request by just adding `dynamic: true` to your document's meta data (exposes the [express.js](http://expressjs.com/) `req` and `res` objects to your templating engine)
+- Get SEO friendly clean URLs with our [Clean URLs Plugin](https://github.com/bevry/docpad-extras/tree/master/plugins/cleanurls/) (dynamic deployments only)
+- Lint your code automatically with our Lint Plugin - under construction, coming soon
+- Concatenate and minify your JavaScript and CSS assets making page loads faster for your users with our Minify Plugin - under construction, coming soon
+- Install common javascript libraries like jQuery, Backbone and Underscore directly from the command line - under construction, coming soon
+- Automatically translate your entire website into other languages with our Translation Plugin - under construction, coming soon
+- Add a admin interface to your website allowing you to edit, save and preview your changes on live websites then push them back to your source repository with the Admin Plugin - under construction, coming soon
+- Pretty much if DocPad doesn't already do something, it is trivial to [write a plugin](https://github.com/bevry/docpad/wiki/Extending) to do it, seriously DocPad can accomplish anything, it never holds you back, there are no limits, it's like super powered guardian angel
+- There are also [plenty of other plugins](https://github.com/bevry/docpad/wiki/Plugins) not listed here that are still definitely worth checking out! :)

0 comments on commit e3ecfb7

Please sign in to comment.
Something went wrong with that request. Please try again.