Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alexander-schranz committed Feb 10, 2017
1 parent fd4fea4 commit 4ca0d28
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 2 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2016 Sulu

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
40 changes: 38 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,41 @@
# Sulu Form Bundle

This bundle is currently under heavy development!
The SuluFormBundle adds support for creating dynamic forms in Sulu. It can
be used for contact, sweepstake or other forms.

[Documentation](Resources/doc/index.md "Documentation")
**Features**

- Dynamic form builder
- Mail handling
- List view of submitted data

## Status

This repository will become version 1.0 of SuluFormBundle. It is under
**heavy development** and currently its APIs and code are not stable
yet (pre 1.0).

## Requirements

For the requirements check the [composer.json](composer.json "composer.json")
file.

# Documentation / Installation

The Documentation is stored in the
[Documentation](Resources/doc/ "Documentation") folder.

## License

This bundle is under the MIT license. See the complete license
[in the bundle](LICENSE)

## Reporting an issue or a feature request

Issues and feature requests are tracked in the
[Github issue tracker](https://github.com/sulu/SuluFormBundle/issues).

When reporting a bug, it may be a good idea to reproduce it in a basic project
built using the [Sulu Minimal Edition](https://github.com/sulu/sulu-minimal)
to allow developers of the bundle to reproduce the issue by simply cloning it
and following some steps.

0 comments on commit 4ca0d28

Please sign in to comment.