Skip to content

Commit

Permalink
Readmes, licenses and cleanups in prep for open-sourcing
Browse files Browse the repository at this point in the history
  • Loading branch information
maxtaco committed Oct 26, 2015
1 parent c9e83d7 commit bbd87b0
Show file tree
Hide file tree
Showing 5 changed files with 88 additions and 28 deletions.
28 changes: 28 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Copyright (c) 2015, Keybase
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

* Neither the name of keybase nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
## Keybase

* **go**: The Keybase services and command line client. [Learn More](go/README.md)
Welcome to the Keybase client repository! You'll find here everything from our core
crypto libraries to the last-mile UX used to power our mobile and desktop clients. What
we have here is still very much a work-in-progress, with some code more mature than others.


### Code Layout

* **go**: Core crypto libraries; the Keybase service and command line client. [Learn More](go/README.md)
* **electron**: Desktop application for OSX, Linux and Windows, made via the [electron framework](https://github.com/atom/electron) framework
* **packaging**: Scripts for releasing packages across the various platforms.
* **protocol**: Defines the protocol for communication for clients to the Keybase services. Uses [Avro](http://avro.apache.org/docs/1.7.7/). [Learn More](protocol/README.md)
* **osx**: The Mac OS X Keybase.app. [Learn More](osx/README.md)
* **ios**: The iOS Keybase.app. [Learn More](ios/README.md)
* **react-native**: Android and iOS apps developed via the [react-native framework](https://facebook.github.io/react-native/).
* **media**: Icons, graphics, media for Keybase apps.
* **osx**: The Mac OS X Keybase.app; development parallel to an Electron-based application above. [Learn More](osx/README.md)


### Problems?

Expand All @@ -15,3 +25,8 @@ If you're having problem with our Website, try the
[keybase-issues](https://github.com/keybase/keybase-issues) issue tracker.

We check and update both frequently.

### License

Most code is released under the New BSD (3 Clause) License. If subdirectories include
a different license, that license applies instead.
14 changes: 0 additions & 14 deletions go/NOTES.md

This file was deleted.

48 changes: 42 additions & 6 deletions go/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
## Keybase

This repository contains the Keybase core crypto libraries, command-line
utility, and local Keybase service. All code is written in the [Go
Language](https://golang.org), making heavy use of Go's
[OpenPGP](https://godoc.org/golang.org/x/crypto/openpgp) and
[NaCl](https://godoc.org/golang.org/x/crypto/nacl)
[Library](https://github.com/agl/ed25519) implementation.

Our intended architecture is that `keybase` runs a local service on Desktop
environments, which can be connected to over a local Unix domain sockets on OSX/Linux,
and over named pipes on Windows. The persistent service will eventually listen
for asynchronous server updates, and will serve several clients, like the command-line
utility, the graphical desktop app ([see `electron`](../electron)), and the Keybase
FUSE-mounted file system.

For now, the only client ready for production is the command-line utility.

### Status

The Keybase service/client is approaching a release-ready state on OSX and Linux,
with Windows shortly behind. Code in this repository is safe to run against either
our [production site](https://keybase.io) or our [staging server](https://stage0.keybase.io).

### Install production client

#### Mac
Expand All @@ -21,11 +43,9 @@ Download the appropriate package:
### Building

```bash
cd keybase
go get -u
// Nojima: The above wasn't working for me on OS X. In $GOPATH/src/github.com/keybase/client run go get ./...
go build -a
// Nojima: Run the above in $GOPATH/src/github.com/keybase/client/go/keybase
cd $GOPATH/src/github.com/keybase/client/go
export GO15VENDOREXPERIMENT=1 # all dependencies are vendored
go install
```

### Run the service
Expand All @@ -41,11 +61,27 @@ Or specify a custom home directory (and use -d for debug):
./keybase -H ~/Projects/Keybase/dev -d service
```

### Run the client

```bash
./keybase id max
```

### Or you can run the client in "Standalone" Mode

```bash
./keybase --standalone id max
```

### Testing

To test install Boot2Docker and run:
To test install Boot2Docker and run (if you have access to our server code):

```bash
docker build -t kbweb .
make test
```

### License

Most code is released under the New BSD (3 Clause) License.
5 changes: 0 additions & 5 deletions go/TODO.md

This file was deleted.

0 comments on commit bbd87b0

Please sign in to comment.