Skip to content

Commit e0e8e5e

Browse files
author
Yaniv Inbar
committed
[http] readme.html improvements
https://codereview.appspot.com/6495045/
1 parent a05787b commit e0e8e5e

File tree

1 file changed

+125
-151
lines changed

1 file changed

+125
-151
lines changed

‎google-http-client-assembly/readme.html‎

Lines changed: 125 additions & 151 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,64 @@
11
<html>
22
<title>${project.name} ${project.version}</title>
33
<body>
4-
<h2>${project.name} ${project.version}</h2>
4+
<h2>${project.name} ${project.version}</h2>
55

6-
<h3>Overview</h3>
7-
<p>High-level details about this library can be found at <a href="http://code.google.com/p/google-http-java-client">http://code.google.com/p/google-http-java-client</a>
8-
<ul>
9-
<li><a href='http://code.google.com/p/google-http-java-client/wiki/ReleaseNotes#Version_${project.version}'>Release Notes</a></li>
10-
<li><a href='http://javadoc.google-http-java-client.googlecode.com/hg/${project.version}/index.html'>JavaDoc</a></li>
11-
<li><a href='http://code.google.com/p/google-http-java-client/wiki/DeveloperGuide'>Developer's Guide</a></li>
12-
<li><a href='http://groups.google.com/group/google-http-java-client'>Support</a></li>
13-
</ul>
14-
15-
<h3>Library Details</h3>
16-
<ul>
17-
<li>google-http-client can be used for all platforms.</li>
18-
<li>google-http-client-android is for Android SDK 1.6 (Donut) & higher.</li>
19-
<li>[deprecated] google-http-client-android2 is for Android SDK 2.0 & higher.</li>
20-
<li>[deprecated] google-http-client-android3 is for Android SDK 3.0 & higher.</li>
21-
<li>google-http-client-appengine is for Google App Engine.</li>
22-
<li>google-http-client-protobuf is for Protocol Buffer support.</li>
23-
<li>google-http-client-gson is for GSON support.</li>
24-
<li>google-http-client-jackson is for Jackson support.</li>
25-
<li>google-http-client-jackson2 is for Jackson 2 support.</li>
26-
</ul>
6+
<h3>Overview</h3>
7+
<p>
8+
High-level details about this library can be found at <a
9+
href="http://code.google.com/p/google-http-java-client">http://code.google.com/p/google-http-java-client</a>
10+
</p>
11+
<ul>
12+
<li><a
13+
href='http://code.google.com/p/google-http-java-client/wiki/ReleaseNotes#Version_${project.version}'>Release
14+
Notes</a></li>
15+
<li><a
16+
href='http://javadoc.google-http-java-client.googlecode.com/hg/${project.version}/index.html'>JavaDoc</a></li>
17+
<li><a
18+
href='http://code.google.com/p/google-http-java-client/wiki/DeveloperGuide'>Developer's
19+
Guide</a></li>
20+
<li><a href='http://groups.google.com/group/google-http-java-client'>Support</a></li>
21+
</ul>
2722

28-
<h3>Dependencies and Licenses</h3>
29-
The license can be found <a href='LICENSE.txt'>here</a>.<br/>
30-
Dependent jars can be found in the <a href='libs'>libs</a> folder and the corresponding source jars can be found in the <a href='libs-sources'>libs-sources</a> folder.<br/><br/>
31-
The dependency structure and licenses for the different libraries can be found here:
32-
<ul>
33-
<li>google-http-client: <a href='dependencies/dependencies.html'>dependencies.html</a></li>
34-
<li>google-http-client-android: <a href='dependencies/android-dependencies.html'>android-dependencies.html</a></li>
35-
<li>[deprecated] google-http-client-android2: <a href='dependencies/android2-dependencies.html'>android2-dependencies.html</a></li>
36-
<li>[deprecated] google-http-client-android3: <a href='dependencies/android3-dependencies.html'>android3-dependencies.html</a></li>
37-
<li>google-http-client-appengine: <a href='dependencies/appengine-dependencies.html'>appengine-dependencies.html</a></li>
38-
<li>google-http-client-protobuf: <a href='dependencies/protobuf-dependencies.html'>protobuf-dependencies.html</a></li>
39-
<li>google-http-client-gson: <a href='dependencies/gson-dependencies.html'>gson-dependencies.html</a></li>
40-
<li>google-http-client-jackson: <a href='dependencies/jackson-dependencies.html'>jackson-dependencies.html</a></li>
41-
<li>google-http-client-jackson2: <a href='dependencies/jackson2-dependencies.html'>jackson2-dependencies.html</a></li>
42-
</ul>
23+
<h3>Dependencies and Licenses</h3>
24+
The license can be found
25+
<a href='LICENSE.txt'>here</a>.
26+
<br /> Dependent jars can be found in the
27+
<a href='libs'>libs</a> folder and the corresponding source jars can be found
28+
in the
29+
<a href='libs-sources'>libs-sources</a> folder.
30+
<br />
31+
<br /> The dependency structure and licenses for the different libraries can
32+
be found here:
33+
<ul>
34+
<li>google-http-client: <a href='dependencies/dependencies.html'>dependencies.html</a></li>
35+
<li>google-http-client-android: <a
36+
href='dependencies/android-dependencies.html'>android-dependencies.html</a></li>
37+
<li>[deprecated] google-http-client-android2: <a
38+
href='dependencies/android2-dependencies.html'>android2-dependencies.html</a></li>
39+
<li>[deprecated] google-http-client-android3: <a
40+
href='dependencies/android3-dependencies.html'>android3-dependencies.html</a></li>
41+
<li>google-http-client-appengine: <a
42+
href='dependencies/appengine-dependencies.html'>appengine-dependencies.html</a></li>
43+
<li>google-http-client-protobuf: <a
44+
href='dependencies/protobuf-dependencies.html'>protobuf-dependencies.html</a></li>
45+
<li>google-http-client-gson: <a
46+
href='dependencies/gson-dependencies.html'>gson-dependencies.html</a></li>
47+
<li>google-http-client-jackson: <a
48+
href='dependencies/jackson-dependencies.html'>jackson-dependencies.html</a></li>
49+
<li>google-http-client-jackson2: <a
50+
href='dependencies/jackson2-dependencies.html'>jackson2-dependencies.html</a></li>
51+
</ul>
4352

44-
<h3>Maven Usage</h3>
45-
For information on how to add these libraries to your Maven project please see
46-
<a href='http://code.google.com/p/google-http-java-client/wiki/Setup#Maven'>http://code.google.com/p/google-http-java-client/wiki/Setup#Maven</a>.
53+
<h3>Maven Usage</h3>
54+
For information on how to add these libraries to your Maven project please see
55+
<a href='http://code.google.com/p/google-http-java-client/wiki/Setup#Maven'>http://code.google.com/p/google-http-java-client/wiki/Setup#Maven</a>.
4756

48-
<h3>Eclipse</h3>
49-
A .classpath file snippet that can be included in your project's .classpath has been provided <a href='.classpath'>here</a>.
50-
Please only use the classpathentry's you actually need (see below for details).
57+
<h3>Eclipse</h3>
58+
A .classpath file snippet that can be included in your project's .classpath
59+
has been provided
60+
<a href='.classpath'>here</a>. Please only use the classpathentry's you
61+
actually need (see below for details).
5162

5263
<h3>ProGuard</h3>
5364
<p>
@@ -67,116 +78,79 @@ <h3>ProGuard</h3>
6778
ProGuard</a> for more details.
6879
</p>
6980

70-
<h3>Android Dependencies</h3>
71-
The following are the jars from the <a href='libs'>libs</a>
72-
folder required for Android applications or a newer compatible version:
73-
<ul>
74-
<li>google-http-client-${project.version}.jar</li>
75-
<li>google-http-client-android-${project.version}.jar (only for SDK >= 1.6)</li>
76-
<li>[deprecated] google-http-client-android2-${project.version}.jar (only for SDK >= 2.1)</li>
77-
<li>[deprecated] google-http-client-android3-${project.version}.jar (only for SDK >= 3.0)</li>
78-
<li>guava-${project.guava.version}.jar</li>
79-
<li>jsr305-${project.jsr305.version}.jar</li>
80-
<li>
81-
google-http-client-protobuf-${project.version}.jar (when using protobuf-java)
82-
<ul>
83-
<li>protobuf-java-${project.protobuf-java.version}.jar</li>
84-
</ul>
85-
</li>
86-
<li>
87-
google-http-client-gson-${project.version}.jar (when using GSON)
88-
<ul>
89-
<li>gson-${project.gson.version}.jar</li>
90-
</ul>
91-
</li>
92-
<li>
93-
google-http-client-jackson-${project.version}.jar (when using Jackson)
94-
<ul>
95-
<li>jackson-core-asl-${project.jackson-core-asl.version}.jar</li>
96-
</ul>
97-
</li>
98-
<li>
99-
google-http-client-jackson2-${project.version}.jar (when using Jackson 2)
100-
<ul>
101-
<li>jackson-core-${project.jackson-core2.version}.jar</li>
102-
</ul>
103-
</li>
104-
</ul>
105-
The <a href='libs'>libs</a> folder also contains properties files that specify the location of source jars for Android projects in Eclipse.<br/>
106-
Please see the <a href='http://code.google.com/p/google-http-java-client/wiki/Android'>Android wiki</a> for the Android Developer's Guide.
81+
<h3>Dependencies for all Platforms</h3>
82+
The following are the jars from the
83+
<a href='libs'>libs</a> folder needed for applications on all platform:
84+
<ul>
85+
<li>google-http-client-${project.version}.jar</li>
86+
<li>guava-${project.guava.version}.jar</li>
87+
<li>jsr305-${project.jsr305.version}.jar</li>
88+
<li>google-http-client-protobuf-${project.version}.jar (when using
89+
protobuf-java)
90+
<ul>
91+
<li>protobuf-java-${project.protobuf-java.version}.jar</li>
92+
</ul>
93+
</li>
94+
<li>google-http-client-gson-${project.version}.jar (when using GSON)
95+
<ul>
96+
<li>gson-${project.gson.version}.jar</li>
97+
</ul>
98+
</li>
99+
<li>google-http-client-jackson-${project.version}.jar (when using
100+
Jackson)
101+
<ul>
102+
<li>jackson-core-asl-${project.jackson-core-asl.version}.jar</li>
103+
</ul>
104+
</li>
105+
<li>google-http-client-jackson2-${project.version}.jar (when using
106+
Jackson 2)
107+
<ul>
108+
<li>jackson-core-${project.jackson-core2.version}.jar</li>
109+
</ul>
110+
</li>
111+
</ul>
112+
113+
<h3>Android Dependencies</h3>
114+
The following are the jars from the
115+
<a href='libs'>libs</a> folder required for Android applications or a newer
116+
compatible version:
117+
<ul>
118+
<li>google-http-client-android-${project.version}.jar (for SDK >= 1.6)</li>
119+
<li>[deprecated] google-http-client-android2-${project.version}.jar
120+
(only for SDK >= 2.1)</li>
121+
<li>[deprecated] google-http-client-android3-${project.version}.jar
122+
(only for SDK >= 3.0)</li>
123+
</ul>
124+
The
125+
<a href='libs'>libs</a> folder also contains properties files that specify the
126+
location of source jars for Android projects in Eclipse.
127+
<br /> Please see the
128+
<a href='http://code.google.com/p/google-http-java-client/wiki/Android'>Android
129+
wiki</a> for the Android Developer's Guide.
107130

108-
<h3>Google App Engine Dependencies</h3>
109-
The following are the jars from the <a href='libs'>libs</a>
110-
folder required for Google App Engine applications or a newer compatible version:
111-
<ul>
112-
<li>google-http-client-${project.version}.jar</li>
113-
<li>google-http-client-appengine-${project.version}.jar</li>
114-
<li>guava-${project.guava.version}.jar</li>
115-
<li>jsr305-${project.jsr305.version}.jar</li>
116-
<li>
117-
google-http-client-protobuf-${project.version}.jar (when using protobuf-java)
118-
<ul>
119-
<li>protobuf-java-${project.protobuf-java.version}.jar</li>
120-
</ul>
121-
</li>
122-
<li>
123-
google-http-client-gson-${project.version}.jar (when using GSON)
124-
<ul>
125-
<li>gson-${project.gson.version}.jar</li>
126-
</ul>
127-
</li>
128-
<li>
129-
google-http-client-jackson-${project.version}.jar (when using Jackson)
130-
<ul>
131-
<li>jackson-core-asl-${project.jackson-core-asl.version}.jar</li>
132-
</ul>
133-
</li>
134-
<li>
135-
google-http-client-jackson2-${project.version}.jar (when using Jackson 2)
136-
<ul>
137-
<li>jackson-core-${project.jackson-core2.version}.jar</li>
138-
</ul>
139-
</li>
140-
<li>xpp3-${project.xpp3.version}.jar</li>
141-
</ul>
142-
Please see the <a href='http://code.google.com/p/google-http-java-client/wiki/GoogleAppEngine'>GoogleAppEngine wiki</a> for the Google App Engine Developer's Guide.
131+
<h3>Google App Engine Dependencies</h3>
132+
The following are the jars from the
133+
<a href='libs'>libs</a> folder required for Google App Engine applications or
134+
a newer compatible version:
135+
<ul>
136+
<li>google-http-client-appengine-${project.version}.jar</li>
137+
<li>xpp3-${project.xpp3.version}.jar</li>
138+
</ul>
139+
Please see the
140+
<a
141+
href='http://code.google.com/p/google-http-java-client/wiki/GoogleAppEngine'>GoogleAppEngine
142+
wiki</a> for the Google App Engine Developer's Guide.
143143

144-
<h3>General Purpose Java 5 Environment Dependencies</h3>
145-
The following are the jars from the <a href='libs'>libs</a>
146-
folder required for general purpose Java 5 applications or a newer compatible version:
147-
<ul>
148-
<li>google-http-client-${project.version}.jar</li>
149-
<li>commons-logging-${project.commons-logging.version}.jar</li>
150-
<li>guava-${project.guava.version}.jar</li>
151-
<li>httpclient-${project.httpclient.version}.jar</li>
152-
<li>httpcore-${project.httpcore.version}.jar</li>
153-
<li>jsr305-${project.jsr305.version}.jar</li>
154-
<li>xpp3-${project.xpp3.version}.jar</li>
155-
<li>
156-
google-http-client-protobuf-${project.version}.jar (when using protobuf-java)
157-
<ul>
158-
<li>protobuf-java-${project.protobuf-java.version}.jar</li>
159-
</ul>
160-
</li>
161-
<li>
162-
google-http-client-gson-${project.version}.jar (when using GSON)
163-
<ul>
164-
<li>gson-${project.gson.version}.jar</li>
165-
</ul>
166-
</li>
167-
<li>
168-
google-http-client-jackson-${project.version}.jar (when using Jackson)
169-
<ul>
170-
<li>jackson-core-asl-${project.jackson-core-asl.version}.jar</li>
171-
</ul>
172-
</li>
173-
<li>
174-
google-http-client-jackson2-${project.version}.jar (when using Jackson 2)
175-
<ul>
176-
<li>jackson-core-${project.jackson-core2.version}.jar</li>
177-
</ul>
178-
</li>
179-
</ul>
144+
<h3>General Purpose Java 5 Environment Dependencies</h3>
145+
The following are the jars from the
146+
<a href='libs'>libs</a> folder required for general purpose Java 5
147+
applications or a newer compatible version:
148+
<ul>
149+
<li>commons-logging-${project.commons-logging.version}.jar</li>
150+
<li>httpclient-${project.httpclient.version}.jar</li>
151+
<li>httpcore-${project.httpcore.version}.jar</li>
152+
<li>xpp3-${project.xpp3.version}.jar</li>
153+
</ul>
180154

181155
</body>
182156
</html>

0 commit comments

Comments
 (0)