gobuilder improvements
- README.md - install.sh script - LICENSE - trigger in main repo
Juan Batiz-Benet committed
Apr 2, 2015 at 03:00 UTC
20b5f96e6a6a6983ef1384ee3ddf395c16e1dbeb
6 files changed
+96
-26
.gobuilder.yml
new
+3
@@ -0,0 +1,3 @@
1
+---
2
+triggers:
3
+ - github.com/Luzifer/gobuilder/cmd/starter
cmd/ipfs/.gobuilder.yml
new
+5
@@ -0,0 +1,5 @@
1
+---
2
+artifacts:
3
+ - dist/README.md
4
+ - dist/LICENSE
5
+ - dist/install.sh
cmd/ipfs/README.md
+18
-26
@@ -1,38 +1,30 @@
1
-# go-ipfs/cmd/ipfs
1
+# [go-ipfs/cmd/ipfs](http://github.com/ipfs/go-ipfs/tree/master/cmd/ipfs)
2
3
-This is the ipfs commandline tool. For now, it's the main entry point to using IPFS. Use it.
3
+
4
5
-```
6
-> go build
7
-> go install
8
-> ipfs
9
-ipfs - global versioned p2p merkledag file system
10
-
11
-Basic commands:
5
+This is the ipfs commandline tool. For now, it's the main entry point to using IPFS.
6
13
- init Initialize ipfs local configuration
14
- add <path> Add an object to ipfs
15
- cat <ref> Show ipfs object data
16
- ls <ref> List links from an object
7
18
-Tool commands:
8
+## Install from source
9
20
- config Manage configuration
21
- update Download and apply go-ipfs updates
22
- version Show ipfs version information
23
- commands List all available commands
10
+```
11
+go install
12
+ipfs
13
+```
14
25
-Advanced Commands:
15
+## Install from [gobuilder.me](https://gobuilder.me/)
16
27
- mount Mount an ipfs read-only mountpoint
28
- serve Serve an interface to ipfs
29
- diag Print diagnostics
17
+If you're viewing this in [gobuilder](https://gobuilder.me/github.com/ipfs/go-ipfs/cmd/ipfs), chose the binary that suits you best at the end of this page. Download it, unzip it, and move the binary into place.
18
31
-Plumbing commands:
19
+## Usage
20
33
- block Interact with raw blocks in the datastore
34
- object Interact with raw dag nodes
21
+```sh
22
+# initialize an ipfs node
23
+ipfs init
24
25
+# list some commands
26
+ipfs
27
37
-Use "ipfs help <command>" for more information about a command.
28
+# get help
29
+ipfs <subcmd> --help
30
```
cmd/ipfs/dist/LICENSE
new
+21
@@ -0,0 +1,21 @@
1
+The MIT License (MIT)
2
+
3
+Copyright (c) 2014 Juan Batiz-Benet
4
+
5
+Permission is hereby granted, free of charge, to any person obtaining a copy
6
+of this software and associated documentation files (the "Software"), to deal
7
+in the Software without restriction, including without limitation the rights
8
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+copies of the Software, and to permit persons to whom the Software is
10
+furnished to do so, subject to the following conditions:
11
+
12
+The above copyright notice and this permission notice shall be included in
13
+all copies or substantial portions of the Software.
14
+
15
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+THE SOFTWARE.
cmd/ipfs/dist/README.md
new
+28
@@ -0,0 +1,28 @@
1
+# ipfs commandline tool
2
+
3
+This is the [ipfs](http://ipfs.io) commandline tool. It contains a full ipfs node.
4
+
5
+## Install
6
+
7
+To install it, move the binary somewhere in your `$PATH`:
8
+
9
+```sh
10
+mv ipfs /usr/local/bin/ipfs
11
+```
12
+
13
+Or run `install.sh` which does this for you.
14
+
15
+## Usage
16
+
17
+First, you must initialize your local ipfs node:
18
+
19
+```sh
20
+ipfs init
21
+```
22
+
23
+This will give you directions to get started with ipfs.
24
+You can always get help with:
25
+
26
+```sh
27
+ipfs --help
28
+```
cmd/ipfs/dist/install.sh
new
+21
@@ -0,0 +1,21 @@
1
+#!/bin/sh
2
+
3
+bin=ipfs
4
+
5
+# this script is currently brain dead.
6
+# it merely tries two locations.
7
+# in the future maybe use value of $PATH.
8
+
9
+binpath=/usr/local/bin
10
+if [ -d "$binpath" ]; then
11
+ mv "$bin" "$binpath/$bin"
12
+ echo "installed $binpath/$bin"
13
+ exit 0
14
+fi
15
+
16
+binpath=/usr/bin
17
+if [ -d "$binpath" ]; then
18
+ mv "$bin" "$binpath/$bin"
19
+ echo "installed $binpath/$bin"
20
+ exit 0
21
+fi