mirror of
https://github.com/owncloud/android-library.git
synced 2025-06-07 16:06:08 +00:00
Update README file and added LICENSE file
This commit is contained in:
parent
5e346043be
commit
e971e5c9e7
24
LICENSE.md
Normal file
24
LICENSE.md
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
### License
|
||||||
|
|
||||||
|
ownCloud Android Library is available under MIT license
|
||||||
|
|
||||||
|
Copyright (C) 2014 ownCloud Inc.
|
||||||
|
Copyright (C) 2012 Bartek Przybylski
|
||||||
|
|
||||||
|
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 HOLDERSBE 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.
|
56
README.md
56
README.md
@ -1,4 +1,4 @@
|
|||||||
# ownCloud Android Library v1.0
|
# ownCloud Android Library
|
||||||
|
|
||||||
### Introduction
|
### Introduction
|
||||||
Using ownCloud Android library it will be the easiest way to communicate with ownCloud servers.
|
Using ownCloud Android library it will be the easiest way to communicate with ownCloud servers.
|
||||||
@ -12,45 +12,45 @@ Get this code and compile it. In the repository it is not only the library proje
|
|||||||
#### 2.2. Add library to your project
|
#### 2.2. Add library to your project
|
||||||
There are different ways of adding this library to your code, then it is described one of them
|
There are different ways of adding this library to your code, then it is described one of them
|
||||||
|
|
||||||
__Step 1.__ Compile the ownCloud Android Library
|
__Step 1.__ Compile the ownCloud Android Library
__Step 2.__ Define a dependency within your project. For that, access to Properties > Android > Library and click on add and select the ownCloud Android library
|
||||||
|
|
||||||
__Step 2.__ Define a dependency within your project. For that, access to Properties > Android > Library and click on add and select the ownCloud Android library
|
### Branching strategy
|
||||||
|
|
||||||
|
The repository holds two main branches with an infinite lifetime:
|
||||||
|
|
||||||
|
- master
|
||||||
|
- develop
|
||||||
|
|
||||||
|
Branch __origin/master__ is considered the main branch where the source code of HEAD always reflects a production-ready state.
|
||||||
|
|
||||||
|
Branch __origin/develop__ is considered the main branch where the source code of HEAD always reflects a state with the latest delivered development changes for the next release.
|
||||||
|
|
||||||
|
When the source code in the develop branch reaches a stable point and is ready to be released, all of the changes should be merged back into master somehow and then tagged with a release number.
|
||||||
|
|
||||||
|
Other branches, some supporting branches are used to aid parallel development between team members, ease tracking of features, prepare for production releases and to assist in quickly fixing live production problems. Unlike the main branches, these branches always have a limited life time, since they will be removed eventually.
|
||||||
|
|
||||||
|
The different types of branches we may use are:
|
||||||
|
|
||||||
|
- Branch __perNewFeature__
|
||||||
|
- Branch __releaseBranches__
|
||||||
|
|
||||||
|
Both of them branch off from develop and must merge back into develop branch through a Pull Request in Github. Once the PR is approved and merged, the US branch may be deleted.
|
||||||
|
|
||||||
|
Source: http://nvie.com/posts/a-successful-git-branching-model
|
||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
ownCloud Android Library is available under MIT license
|
ownCloud Android Library is available under MIT license. See the file LICENSE.md with the full license text.
|
||||||
|
|
||||||
Copyright (C) 2014 ownCloud (http://www.owncloud.org/)
|
|
||||||
|
|
||||||
Copyright (C) 2012 Bartek Przybylski
|
|
||||||
|
|
||||||
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 HOLDERSBE 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.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Third part libraries
|
#### Third part libraries
|
||||||
|
|
||||||
ownCloud Android Library uses Apache JackRabbit, version 2.2.5. Copyright (C) 2004-2010 The Apache Software Foundation. Licensed under Apache License, Version 2.0.
|
ownCloud Android Library uses Apache JackRabbit, version 2.2.5. Copyright (C) 2004-2010 The Apache Software Foundation. Licensed under Apache License, Version 2.0.
|
||||||
|
|
||||||
|
Apache JackRabbit depends on Commons HTTPClient version 3.1 and SLF4j version 1.7.5; both included also. Copyright (C) 2004-2010 The Apache Software Foundation. Licensed under Apache License, Version 2.0.
|
||||||
|
|
||||||
|
|
||||||
### Compatibility
|
### Compatibility
|
||||||
|
|
||||||
ownCloud Android library from Android 2.2 (android:minSdkVersion="8" android:targetSdkVersion="19")
|
ownCloud Android Library is valid for Android systems from version Android 2.2 (android:minSdkVersion="8" android:targetSdkVersion="19").
|
||||||
|
|
||||||
ownCloud Android library supports ownCloud server from version 4.5.
|
ownCloud Android library supports ownCloud server from version 4.5.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user