forked from square/tape
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
72 lines (71 loc) · 4.4 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Tape - A collection of queue-related classes for Android and Java by Square, Inc.</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="A collection of queue-related classes for Android and Java by Square, Inc." />
<link href="bootstrap.min.css" rel="stylesheet">
<link href="bootstrap-responsive.min.css" rel="stylesheet">
<link href="prettify.css" rel="stylesheet">
<link href="app.css" rel="stylesheet">
<script src="http://code.jquery.com/jquery-latest.js"></script>
<script src="jquery-maven-artifact.min.js"></script>
</head>
<body>
<div class="container content">
<div class="row titlebar">
<div class="span12">
<h1>Tape</h1>
</div>
</div>
<div class="row">
<div class="span6">
<h2 id="about">About</h2>
<p>Tape is a collection of queue-related classes for Android and Java by Square, Inc.</p>
<p><code>QueueFile</code> is a lightning-fast, transactional, file-based FIFO. Addition and removal from an instance is an O(1) operation and is atomic. Writes are synchronous; data will be written to disk before an operation returns. The underlying file is structured to survive process and even system crashes and if an I/O exception is thrown during a mutating change, the change is aborted.</p>
<p>An <code>ObjectQueue</code> represents an ordering of arbitrary objects which can be backed either by the filesystem (via <code>QueueFile</code>) or in memory only.</p>
</div>
<div class="span5 offset1">
<h2 id="download">Download</h2>
<p>Available via Maven or as a downloadable <code>.jar</code>.</p>
<p><a href="https://search.maven.org/remote_content?g=com.squareup.tape2&a=tape&v=LATEST" class="btn btn-inverse btn-large" id="download-btn">Download Latest</a></p>
<p><a href="http://github.com/square/tape" id="ribbon">Fork Tape on GitHub</a></p>
<pre class="maven"><dependency>
<groupId>com.squareup.tape2</groupId>
<artifactId>tape</artifactId>
<version><span id="mvn-version"><em>(insert latest)</em></span></version>
</dependency></pre>
</div>
</div>
<div class="row">
<div class="span6">
<h2 id="contribute">Contribute</h2>
<p>If you would like to contribute code to Tape you can do so through GitHub by forking the repository and sending a pull request.</p>
<p>When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible. Please also make sure your code compiles by running <code>mvn clean verify</code>. Checkstyle failures during compilation indicate errors in your style and can be viewed in the <code>target/checkstyle-result.xml</code> file.</p>
<p>Before your code can be accepted into the project you must also sign the <a href="https://spreadsheets.google.com/spreadsheet/viewform?formkey=dDViT2xzUHAwRkI3X3k5Z0lQM091OGc6MQ&ndplr=1">Individual Contributor License Agreement (CLA)</a>.</p>
</div>
<div class="span6 license">
<h2 id="license">License</h2>
<p>Copyright 2012 Square, Inc.</p>
<p>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</p>
<blockquote>http://www.apache.org/licenses/LICENSE-2.0</blockquote>
<p>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.</p>
</div>
</div>
</div>
<div class="footer">
<a href="http://squareup.com"><img src="square.png" alt="Square, Inc."/></a>
</div>
<script src="prettify.js"></script>
<script> prettyPrint(); </script>
<script>
// Look up the latest version of the library.
$.fn.artifactVersion('com.squareup.tape2', 'tape', function(version, url) {
$('#mvn-version').text(version);
$('#download-btn').text('Download v' + version).attr('href', url);
});
</script>
</body>
</html>