Skip to content

Commit 8822434

Browse files
committedMay 21, 2011
Add a real readme
1 parent 6f24116 commit 8822434

File tree

8 files changed

+5097
-5
lines changed

8 files changed

+5097
-5
lines changed
 

‎LICENSE.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Copyright (c) 2011 Daniel Lucraft
2+
3+
Permission is hereby granted, free of charge, to any person obtaining
4+
a copy of this software and associated documentation files (the
5+
"Software"), to deal in the Software without restriction, including
6+
without limitation the rights to use, copy, modify, merge, publish,
7+
distribute, sublicense, and/or sell copies of the Software, and to
8+
permit persons to whom the Software is furnished to do so, subject to
9+
the following conditions:
10+
11+
The above copyright notice and this permission notice shall be
12+
included in all copies or substantial portions of the Software.
13+
14+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README

-5
This file was deleted.

‎README.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
2+
git.js
3+
======
4+
5+
[Daniel Lucraft](http://danlucraft.com)
6+
[@danlucraft](http://twitter.com/danlucraft)
7+
8+
A git implementation in pure JavaScript.
9+
10+
Has two clients:
11+
12+
* a command-line node.js client,
13+
* and an in-browser repo API for accessing git through the HTTP protocol
14+
15+
Status
16+
------
17+
18+
The command-line version currently implements:
19+
20+
* git.js log (shows 10 commits)
21+
* git.js branch (listing local branches)
22+
* git.js show SHA (show object information)
23+
24+
The client side API implements:
25+
26+
* creating an in-memory repo
27+
* fetching remote objects through the dumb or smart HTTP git protocols
28+
* browsing the object graph
29+
* creating HTML object diffs
30+
31+
Plans
32+
-----
33+
34+
* package for npm
35+
* writing to repos: committing, branching
36+
* improving the client side API
37+
* making it easy to run the included demo repo-viewer webapp
38+
39+
License
40+
-------
41+
42+
Released under the MIT License. See the [LICENSE][license] file for further details.
43+
44+
[license]: https://github.com/danlucraft/git.js/blob/master/LICENSE.md

‎Rakefile

+13
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,17 @@ namespace :test do
1313
end
1414
rm_rf "test-repo"
1515
end
16+
end
17+
18+
desc "Concatenate the javascript for the client"
19+
task :package_client do
20+
load_file = File.read(File.dirname(__FILE__) + "/lib/git-client.js")
21+
paths = load_file.scan(/getScript\("\/([^"]*)"\)/)
22+
js = ["jsGitInNode = false"]
23+
paths.each do |path|
24+
js << File.read(File.dirname(__FILE__) + "/" + path.first)
25+
end
26+
total_js = js.join("\n\n")
27+
File.open("lib/git.min.js", "w") {|f| f.puts total_js }
28+
[200, {"Content-Type" => "text/javascript"}, [total_js]]
1629
end
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)