Skip to content
Newer
Older
100644 80 lines (50 sloc) 2.15 KB
9efdbc1 updated README
Hilary Mason authored Dec 17, 2010
1 ========
2 Gitmarks
3 ========
4
5 A web bookmark manager built on git and designed for github. It's searchable and social!
6
7 Gitmarks is a script that, given a URL, description, and tags, will download the content of the web page and store it along with the metadata so that you can easily search it (with grep!) and comment on it (with github!)
8
9 It's great for groups to collaboratively collect bookmarks in one spot (thanks to git itself!)
10
11 =======
12 Details
13 =======
14
15 For each URL, gitmarks will pull the content and store it under the 'content' directory. It stores the metadata under each tag in the 'tags' directory.
16
17 You can use git as usual to see who committed what and when, or you can grep your way to bookmark happiness on the command line.
18
19 =====
20 Usage
21 =====
22
23 python gitmark.py [url]
24
25 options:
26 -p = do not push to origin (store bookmark locally only)
27 -m = description of the bookmark
28 -t = a comma-delimited list of tags
29
30 Example:
31
32 python gitmark.py -m 'my site' -t me,hilary_mason,code,bookmarks http://www.hilarymason.com
517ed25 added license and delicious_import.py to readme
Hilary Mason authored Dec 17, 2010
33
34
35 ===============
36 OMG Delicious?!
37 ===============
38
39 Yes, you can import your delicious bookmarks!
40
41 Usage:
42
43 python delicious_import.py [username] [password]
44
45 (be patient if you have a lot of them.)
46
9bc7be5 @jcn Simple bookmarklet/web interface for gitmark
jcn authored Dec 17, 2010
47
c9e3106 moved web port to settings and elaborated on README
Hilary Mason authored Dec 18, 2010
48 =============================
49 Using the Browser Bookmarklet
50 =============================
9bc7be5 @jcn Simple bookmarklet/web interface for gitmark
jcn authored Dec 17, 2010
51
c9e3106 moved web port to settings and elaborated on README
Hilary Mason authored Dec 18, 2010
52 First, run the gitmark_web server:
9bc7be5 @jcn Simple bookmarklet/web interface for gitmark
jcn authored Dec 17, 2010
53
54 python gitmark_web.py
55
3ca0fed @jcn Add index page to gitmark_web with link to the bookmarklet
jcn authored Dec 18, 2010
56 Then, go to the following URL and drag the bookmarklet into your browser's toolbar:
9bc7be5 @jcn Simple bookmarklet/web interface for gitmark
jcn authored Dec 17, 2010
57
3ca0fed @jcn Add index page to gitmark_web with link to the bookmarklet
jcn authored Dec 19, 2010
58 http://localhost:44865/
59
60 (where 44865 is the port you set in settings.py)
9bc7be5 @jcn Simple bookmarklet/web interface for gitmark
jcn authored Dec 17, 2010
61
62
517ed25 added license and delicious_import.py to readme
Hilary Mason authored Dec 17, 2010
63 =======
64 License
65 =======
66
67 Copyright 2010 Hilary Mason.
68
69 This program is free software: you can redistribute it and/or modify
70 it under the terms of the GNU General Public License as published by
71 the Free Software Foundation, either version 3 of the License, or
72 (at your option) any later version.
73
74 This program is distributed in the hope that it will be useful,
75 but WITHOUT ANY WARRANTY; without even the implied warranty of
76 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
77 GNU General Public License for more details.
78
79 You should have received a copy of the GNU General Public License
80 along with this program. If not, see <http://www.gnu.org/licenses/>.
Something went wrong with that request. Please try again.