Merge lp:~jose/charms/precise/shelrtv/add-categories-fix-readme into lp:charms/shelrtv

Proposed by José Antonio Rey
Status: Merged
Approved by: Jorge Castro
Approved revision: 9
Merged at revision: 9
Proposed branch: lp:~jose/charms/precise/shelrtv/add-categories-fix-readme
Merge into: lp:charms/shelrtv
Diff against target: 179 lines (+78/-81)
3 files modified
README (+0/-81)
README.md (+76/-0)
metadata.yaml (+2/-0)
To merge this branch: bzr merge lp:~jose/charms/precise/shelrtv/add-categories-fix-readme
Reviewer Review Type Date Requested Status
Jorge Castro (community) Approve
Review via email: mp+215995@code.launchpad.net

Description of the change

 * Added category
 * Reformatted README to Markdown

To post a comment you must log in.
Revision history for this message
Jorge Castro (jorge) wrote :

+1 thanks Jose!

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== removed file 'README'
2--- README 2012-04-20 17:47:29 +0000
3+++ README 1970-01-01 00:00:00 +0000
4@@ -1,81 +0,0 @@
5-Introduction
6-============
7-
8-Shelr.tv is a service and a tool for terminal screencasting. This charm will deploy
9-the latest Shelr.tv code to provide the web interface found on http://shelr.tv/
10-
11-Deployment
12-==========
13-
14- juju deploy mongodb
15- juju deploy shelr.tv
16- juju add-relation shelr.tv mongodb
17- juju expose shelr.tv
18-
19-Configuration
20-=============
21-
22-Shelr.tv has several additional options for configuration. These are all optional as
23-the primary charm will deploy and run without issues; however, if you want to enable
24-different log-in provdiers or configure an "admin" see the following options. At any
25-time you can run `juju get shelr.tv` to investigate all available options for your
26-deployment.
27-
28-google-id:
29-google-secret:
30- The Google Application ID and Secret which can be obtained by registering your app
31- on Google.
32-
33-github-id:
34-github-secret:
35- The Github Application ID and Secret which can be obtained by registering at
36- the following URL: https://github.com/settings/applications/new
37-
38-twitter-id:
39-twitter-secret:
40- The Twitter Application ID and Secret which can be obtained by registering at
41- the following URL: https://dev.twitter.com/apps/new
42-
43-god:
44- This will apply "god" access to the supplied User ID, The user ID can be derived
45- from the User profile URL, eg: http://shelr.tv/users/4f809ab19660802ca6000001 in
46- this example 4f809ab19660802ca6000001 would be the user's ID and would be supplied
47- as the VALUE for this option
48-
49-
50-To set one or more of these configuration options run the following command
51-
52- juju set shelr.tv OPTION=VALUE [OPTION=VALUE ...]
53-
54-Where OPTION is one of the aforementioned configuration options, and VALUE is the
55-value you wish to set for that option. You can set as many options as you'd like
56-in a single command by continuing to set additional values. An example below:
57-
58- juju set shelr.tv google-id=YourGoogleApplicationID google-secret=YourSecretKey god=8675309
59-
60-Future
61-======
62-
63-The author reports that pure OpenID support will be added soon, which will negate
64-the need to use github, twitter, and google settings for login.
65-
66-Troubleshooting
67-===============
68-
69- - Browser says: Can not connect to server
70- Make sure you've executed `juju expose shelr.tv`
71-
72- - Browser still says: Can not connect to server
73- It can sometimes take several minutes for the WEBrick Ruby Server to start for the
74- first time, if you've recently performed the add-relation command, waiting up to
75- five minutes before reporting a bug is recommended.
76- - Local shelr won't publish to my new site
77- The shelr client was just recently updated to allow for multiple shelr.tv instances
78- as such, run `gem upgrade` to pull the latest version down. Once updated get the API
79- key for your user from the deployed Juju instance and the public-address for the
80- instance and run the following command:
81-
82- shelr setup [API_KEY] [PUBLIC-ADDRESS]
83-
84- This will setup shelr to push all recordings to your new instance. At this time there
85- is no way to switch hosts on the fly during pushing.
86
87=== added file 'README.md'
88--- README.md 1970-01-01 00:00:00 +0000
89+++ README.md 2014-04-16 02:58:38 +0000
90@@ -0,0 +1,76 @@
91+# Introduction
92+
93+Shelr.tv is a service and a tool for terminal screencasting. This charm will
94+deploy the latest Shelr.tv code to provide the web interface found on
95+http://shelr.tv/
96+
97+# Deployment
98+
99+ juju deploy mongodb
100+ juju deploy shelrtv
101+ juju add-relation shelrtv mongodb
102+ juju expose shelrtv
103+
104+# Configuration
105+
106+Shelr.tv has several additional options for configuration. These are all
107+optional as the primary charm will deploy and run without issues; however, if
108+you want to enable different log-in provdiers or configure an "admin" see the
109+following options. At any time you can run `juju get shelrtv` to investigate all
110+available options for your deployment.
111+
112+`google-id`, `google-secret`: The Google Application ID and Secret which can be
113+obtained by registering your app on Google.
114+
115+`github-id`, `github-secret`: The Github Application ID and Secret which can be
116+obtained by [registering the application on
117+GitHub](https://github.com/settings/applications/new).
118+
119+`twitter-id`, `twitter-secret`: The Twitter Application ID and Secret which can
120+be obtained by [registering the application on
121+Twitter](https://dev.twitter.com/apps/new).
122+
123+`god`: This will apply "god" access to the supplied User ID, The user ID can be
124+derived from the User profile URL, eg:
125+http://shelr.tv/users/4f809ab19660802ca6000001. In this example
126+4f809ab19660802ca6000001 would be the user's ID and would be supplied as the
127+VALUE for this option
128+
129+
130+To set one or more of these configuration options run the following command
131+
132+ juju set shelrtv OPTION=VALUE [OPTION=VALUE ...]
133+
134+Where OPTION is one of the aforementioned configuration options, and VALUE is the
135+value you wish to set for that option. You can set as many options as you'd like
136+in a single command by continuing to set additional values. An example below:
137+
138+ juju set shelrtv google-id=YourGoogleApplicationID google-secret=YourSecretKey god=8675309
139+
140+# Future
141+
142+The author reports that pure OpenID support will be added soon, which will negate
143+the need to use github, twitter, and google settings for login.
144+
145+# Troubleshooting
146+
147+ - Browser says: Can not connect to server: Make sure you've executed `juju expose shelrtv`
148+ - Browser still says: Can not connect to server: It can sometimes take several
149+minutes for the WEBrick Ruby Server to start for the first time, if you've
150+recently performed the add-relation command, waiting up to five minutes before
151+reporting a bug is recommended.
152+ - Local shelr won't publish to my new site: The shelr client was just recently
153+updated to allow for multiple shelr.tv instances, as such, run `gem upgrade` to
154+pull the latest version down. Once updated get the API key for your user from
155+the deployed Juju instance and the public-address for the instance and run the
156+following command:
157+
158+ shelr setup [API_KEY] [PUBLIC-ADDRESS]
159+
160+This will setup shelr to push all recordings to your new instance. At this time
161+there is no way to switch hosts on the fly during pushing.
162+
163+# Contact Information
164+## Shelr.tv
165+
166+ - [Shelr.tv website](http://shelr.tv/)
167
168=== modified file 'metadata.yaml'
169--- metadata.yaml 2013-03-26 12:00:07 +0000
170+++ metadata.yaml 2014-04-16 02:58:38 +0000
171@@ -4,6 +4,8 @@
172 description: |
173 Shelr.tv is a service and a tool for terminal screencasting. Service allow you to share your terminal
174 records like this (http://shelr.tv/records/4f427daf96a5690001000003)
175+categories:
176+ - applications
177 provides:
178 website:
179 interface: http

Subscribers

People subscribed via source and target branches

to all changes: