Skip to content

Commit

Permalink
docs: update main README and add IPFS dual licence
Browse files Browse the repository at this point in the history
  • Loading branch information
aeddi committed Dec 1, 2019
1 parent a2d211d commit 2571805
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 206 deletions.
201 changes: 0 additions & 201 deletions LICENSE

This file was deleted.

5 changes: 5 additions & 0 deletions LICENSE-APACHE
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
19 changes: 19 additions & 0 deletions LICENSE-MIT
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
The MIT License (MIT)

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.
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ _:warning: this repo is planned to be moved on the IPFS organization_
* Lower watermarks in conn manager
* Use QUIC transport to be more resilient in case of switching between wifi/cellular
* Background uploads & tasks
* Connections prioritization by assigning them weight depending on their types, the platform, and the connectivity context
* Connections prioritization by assigning them weight depending on their types, the platform and the connectivity context
* Solutions we'd like to see
* Native libp2p implementations
* Better discovery of peers
* Better cache solutions to avoid a long warm-up that doesn't fit in a short time frame (switch foreground -> background)
* Better caching solutions to avoid a long warm-up that doesn't fit in a short time frame (switch foreground -> background)
* Shared resources for mobile IPFS best practices
* [**gomobile-ipfs** issues](https://github.com/berty/gomobile-ipfs/issues) _(this repo)_
* [**go-ipfs** issues](https://github.com/ipfs/go-ipfs/issues)
Expand All @@ -44,7 +44,22 @@ _(alphabetically sorted)_

## Install

_FIXME: TODO_
### Prerequisites

* For Android: you need to install and configure properly the Android SDK/NDK on your machine
* For iOS: you need to install XCode on a macOS machine

_More info [here](https://godoc.org/golang.org/x/mobile/cmd/gomobile#hdr-Build_a_library_for_Android_and_iOS)_

### Build

* Run `make build.android` or `make build.ios`

_Run `make` to display the command list_

### Code example

* A code example/demo is available [here](./example/react-native)

## Maintainers

Expand All @@ -58,5 +73,4 @@ The current maintainers of this repo are (sorted alphabetically):

## License


_FIXME: TODO_
Dual [MIT](./LICENSE-MIT)/[Apache-2.0](./LICENSE-APACHE) license

0 comments on commit 2571805

Please sign in to comment.