Skip to content

README tweaks based on the new template #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 5, 2013
Merged

README tweaks based on the new template #54

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Symfony CMF SimpleCms Bundle
# Symfony CMF Simple CMS Bundle
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if there's an agreed style here; I've tended to use forms like "SimpleCMSBundle" in references/links, or "Simple CMS Bundle" in the main title. I don't mid "SimpleCMSBundle", not so keen on "SimpleCMS Bundle" because it seems inconsistent, but can go back to that if it's the preferred style.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if theres a precedent, but I agree your change is better.


[![Build Status](https://secure.travis-ci.org/symfony-cmf/SimpleCmsBundle.png)](http://travis-ci.org/symfony-cmf/SimpleCmsBundle)
[![Latest Stable Version](https://poser.pugx.org/symfony-cmf/simple-cms-bundle/version.png)](https://packagist.org/packages/symfony-cmf/simple-cms-bundle)
Expand All @@ -7,18 +7,25 @@
This bundle is part of the [Symfony Content Management Framework (CMF)](http://cmf.symfony.com/)
and licensed under the [MIT License](LICENSE).

A trivial content management system based on the [Symfony Cmf](https://github.com/symfony-cmf/symfony-cmf)
The SimpleCmsBundle builds on other Symfony CMF components. It provides a
solution that can easily map content, routes and menu items based on a single
tree structure in the content repository.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i merged as its a lot better than the previous readme.

we might think some more how we could formulate our pitch here so that people with little knowledege of the cmf understand what this bundle does.


While the core CMF components focus on flexibility, the Simple CMS Bundle
trades away some of that flexibility in favor of simplicity.


## Requirements

* Symfony 2.2.x
* See also the `require` section of [composer.json](composer.json)


## Documentation

For the install guide and reference, see:

* [SimpleCmsBundle documentation](http://symfony.com/doc/master/cmf/bundles/simple-cms-bundle.html)
* [SimpleCmsBundle documentation](http://symfony.com/doc/master/cmf/bundles/simple_cms.html)
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Original link seems to be broken, unless there's a pending change in the works.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, your new link is the right one.


See also:

Expand Down