Skip to content
This repository was archived by the owner on Nov 10, 2022. It is now read-only.

Commit 72373fb

Browse files
Updated Readme.md to contain more information about AngularFaces.
1 parent bb0266a commit 72373fb

File tree

1 file changed

+32
-17
lines changed

1 file changed

+32
-17
lines changed

Diff for: README.md

+32-17
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,24 @@
11
AngularFaces and BabbageFaces
22
=============================
3+
AngularFaces is a JSF component library aiming to simplify JSF development by allowing you to replace a lot of clever AJAX code with simple AngularJS code. AngularFaces approach to simplicity allows you to reduce boilerplate code as well as an easy way to integrate AngularJS with JSF.
34

4-
<b>AngularFaces 2.1 has been released!</b>
5+
Key features involves:
6+
- **Bringing JSR 303 annotations to the client.**
7+
- **Labeled input fiends.**
8+
- **Validating constraints as you type.**
9+
- **Easy integration with AngularJS.**
510

11+
AngularFaces 2.1 provides AngularJS integration in Apache MyFaces, Oracle Mojarra, OmniFaces, PrimeFaces, BootsFaces and the new HTML5 friendly style. It doesn't define widgets of its own. Instead it supports most JSF and PrimeFaces widgets out of the box. Consider it a plug-in taking PrimeFaces and BootsFaces to a whole new level.
12+
13+
The AngularJS and AngularDart widgets I already implemented have been moved to a widgets subproject ("AngularFaces-widgets"). Those widgets make the AngularFaces experience even more fun, but they aren't necessary.
14+
15+
To learn more about AngularFaces have a look at: [ https://www.angularFaces.net ](https://www.angularFaces.net) and [http://www.beyondjava.net/blog/angularfaces-jsf-beyond-ajax/](http://www.beyondjava.net/blog/angularfaces-jsf-beyond-ajax/)
16+
17+
[Learn more about how to get started with AngularFaces.](http://www.beyondjava.net/blog/started-angularfaces)
18+
19+
Installation
20+
---------
21+
####**Maven**
622
Add these lines to your Maven pom.xml file:
723
```XML
824
<dependency>
@@ -13,26 +29,25 @@ Add these lines to your Maven pom.xml file:
1329
</dependency>
1430
```
1531

16-
<b>AngularFaces</b> is a JSF library making it easy to integrate AngularJS code.<br>
32+
Contributing
33+
---------
34+
AngularFaces happily accepts contributions to evolve the projects every aspect. The development of AngularFaces happens here as open source on GitHub. We are gratefull to the community for contributions through issues found using AngularFaces as well as bugfixes and improovements.
1735

18-
AngularFaces 2.1 provides AngularJS integration in Apache MyFaces, Oracle Mojarra, OmniFaces, PrimeFaces, BootsFaces and the new HTML5 friendly style. It doesn't define widgets of its own. Instead it
19-
supports most JSF and PrimeFaces widgets out of the box. Consider it a plug-in taking PrimeFaces and BootsFaces to a whole new level.
36+
####**Information for contributors**
37+
- AngularFaces-core currently runs under MyFaces or Mojarra, both with or without PrimeFaces and / or BootsFaces.
38+
- The Javascript version of the widget library ought the run, but it has not beed tested after extracting the core project so it is not guaranteed to work as expected.
39+
- AngularDart/Prime is currently broken due to API changes of the AngularDart team. Currently I'm waiting for an announced API change to be released, so I put AngularDart/Prime on hold. As a consequence the Dart version of AngularFaces is temporarily stopped, too.
2040

21-
Therefore the AngularJS and AngularDart widgets I already implemented have been moved to a widgets subproject ("AngularFaces-widgets"). Those widgets make
22-
the AngularFaces experience even more fun, but they aren't necessary.
41+
####**Getting started contributing**
42+
If you want to contribute code, fork this repository and then commit your changes to your fork. When you are finished please provide a pull request and it will be reviewed as soon as possible.
2343

24-
<b>State of the art:</b>
25-
<ul>
26-
<li>AngularFaces-core currently runs under MyFaces or Mojarra, both with or without PrimeFaces and / or BootsFaces.</li>
27-
<li>The Javascript version of the widget library ought the run, but I didn't test it yet after extracting the core project, so don't expect too much.</li>
28-
<li>AngularDart/Prime is currently broken due to API changes of the AngularDart team. Currently I'm waiting for an announced API change to be released, so I put
29-
AngularDart/Prime on hold. As a consequence the Dart version of AngularFaces is temporarily stopped, too.</li>
30-
</ul>
31-
32-
To learn more about AngularFaces, have a look at https://www.angularFaces.net and http://www.beyondjava.net/blog/angularfaces-jsf-beyond-ajax/.
33-
34-
There's also a showcase at http://showcase.angularfaces.com demonstrating the older version of AngularFaces 1.0.
44+
####**Reporting Issues**
45+
To file a bug report, please visit the [GitHub issues page](https://github.com/TeamBreak/BManager/issues). Pleace attatch a detailed explanation of your problem or question as well as code if your issue involves code.
3546

3647
Legal disclaimer:
3748
As stated in the Licence conditions, the software is provided on a "as is" basis, without warranties or conditions of any kind. Use at own risk. Read the license file for the details.
3849

50+
Legal
51+
---------
52+
AngularFaces is maintained under the [Apache 2.0 license](https://github.com/stephanrauh/AngularFaces/blob/master/LICENSE).
53+
As stated in the Licence conditions, the software is provided on a "as is" basis, without warranties or conditions of any kind. Use at own risk. Read the license file for the details.

0 commit comments

Comments
 (0)