Fixes method documentation
[GitHub/WoltLab/WCF.git] / README.md
1 WoltLab Community Framework 2.0
2 ===============================
3
4 WoltLab Community Framework is a free web-framework, designed and developed for complex community applications. The framework applies the latest and most modern technologies, it is structured completly object-oriented, constantly enhanced and forms the base for all WoltLab products.
5
6 Version notes
7 -------------
8
9 The currently available source code represents an early alpha-version of WCF, even though it may be installable, we cannot guarantee a working installation at any time. You MUST NOT install and/or use WCF 2.0 in a productive environment.
10
11 **COMPLETE FEATURE FREEZE**
12 New pull requests or suggestions will be declined (or delayed until WCF 2.1); API changes are no longer allowed, unless they solve an already existing issue.
13 This applies to all packages belonging to Community Framework.
14
15 Contribution
16 ------------
17
18 For information on contributing to Community Framework refer to CONTRIBUTING.md in this folder.
19
20 License
21 -------
22
23 This library is free software; you can redistribute it and/or
24 modify it under the terms of the GNU Lesser General Public License
25 as published by the Free Software Foundation; either version 2.1
26 of the License, or (at your option) any later version.
27
28 This library is distributed in the hope that it will be useful,
29 but WITHOUT ANY WARRANTY; without even the implied warranty of
30 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
31 Lesser General Public License for more details.
32
33 You should have received a copy of the GNU Lesser General Public
34 License along with this library; if not, write to the Free Software
35 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA