<p dir="ltr">Okay, lets make the example optional. As long as documentation can be found within 1 or 2 clicks, that should be fine.</p>
<div class="gmail_quote">On Jan 28, 2015 2:35 AM, "Daniel Passos" <<a href="mailto:daniel@passos.me">daniel@passos.me</a>> wrote:<br type="attribution"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr">Hey Lukás,<div><br></div><div>I really don't like the ideia of add the some code snipped on README. I know it's very common and most libraries do this but, it's a lot of code to explain in a README and 2 different places to update when we change/improve/whatever our libraries. I really prefer link to the <a href="http://ag.org" target="_blank">ag.org</a> doc.</div><div><br></div><div>In related news I'd like to add a link to a example app as we did[1] on push library </div><div><br></div><div>[1] <a href="https://github.com/aerogear/aerogear-android-push#demo-apps" target="_blank">https://github.com/aerogear/aerogear-android-push#demo-apps</a></div><div><br></div><div>-- Passos</div><div><br></div></div><div class="gmail_extra"><br><div class="gmail_quote">On Tue, Jan 27, 2015 at 11:47 AM, Lukáš Fryč <span dir="ltr"><<a href="mailto:lukas.fryc@gmail.com" target="_blank">lukas.fryc@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr">Yea, it would be nice if usage would show the code snippet, so Usage would cover:<div><br></div><div>1. how to add the library dependency to your project (which is covered in Android Core README)</div><div>2. a smallest possible snippet of the code that covers how to use the lib (that is not covered atm) + link to respective feature doc if needed</div><div><br></div><div>I like what iOS has here [1], do we want to adopt this pattern for Android, Cordova and JS as well?</div><div><br></div><div>[1] <a href="https://github.com/aerogear/aerogear-ios-oauth2" target="_blank">https://github.com/aerogear/aerogear-ios-oauth2</a></div></div><div><div><div class="gmail_extra"><br><div class="gmail_quote">On Tue, Jan 27, 2015 at 11:24 AM, Corinne Krych <span dir="ltr"><<a href="mailto:corinnekrych@gmail.com" target="_blank">corinnekrych@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">it looks good, I’m just puzzled by the usage section in you gist:<br>
<a href="https://gist.github.com/lfryc/df0c9c9a9ba7acebfd7b#usage" target="_blank">https://gist.github.com/lfryc/df0c9c9a9ba7acebfd7b#usage</a><br>
which contains more build instruction than usage of android-core…<br>
<br>
for our ios readme we have the same content, not foramtted the same way though but it shoudn’t be a pb to reformat.<br>
<br>
++<br>
<span><font color="#888888">Corinne<br>
</font></span><div><div><br>
> On 27 Jan 2015, at 11:22, Sebastien Blanc <<a href="mailto:scm.blanc@gmail.com" target="_blank">scm.blanc@gmail.com</a>> wrote:<br>
><br>
> sounds good !<br>
><br>
> On Tue, Jan 27, 2015 at 11:19 AM, Lukáš Fryč <<a href="mailto:lukas.fryc@gmail.com" target="_blank">lukas.fryc@gmail.com</a>> wrote:<br>
> Hey guys,<br>
><br>
> me and passos brainstormed yesterday about the project info in the README files<br>
><br>
> as it would be nice to unify them across all repositories (discussed elsewhere) and mainly allow people navigate from code repositories directly to locations where they can find more help, etc.<br>
><br>
><br>
> As a result, we both liked:<br>
><br>
> 1. brief Project Info in the header<br>
> 2. more verbose Documentation / Development / Questions? / Found a bug? section in the footer<br>
><br>
> Example for Android Core: <a href="https://gist.github.com/lfryc/df0c9c9a9ba7acebfd7b" target="_blank">https://gist.github.com/lfryc/df0c9c9a9ba7acebfd7b</a><br>
><br>
><br>
> Let me know what you think.<br>
><br>
> If I don't get any -1, I will send pull requests with the updates in all aerogear repositories at the end of this week.<br>
><br>
><br>
> Cheers!<br>
><br>
> ~ Lukas<br>
><br>
><br>
> P.S.: aerogear-users has just a ordinary mailman archive while aerogear-dev uses nabble, which is far better for navigation / search, etc. (the request to add that feature to aerogear-users is tracked in <a href="https://issues.jboss.org/browse/AEROGEAR-1590" target="_blank">https://issues.jboss.org/browse/AEROGEAR-1590</a> )<br>
><br>
> _______________________________________________<br>
> aerogear-dev mailing list<br>
> <a href="mailto:aerogear-dev@lists.jboss.org" target="_blank">aerogear-dev@lists.jboss.org</a><br>
> <a href="https://lists.jboss.org/mailman/listinfo/aerogear-dev" target="_blank">https://lists.jboss.org/mailman/listinfo/aerogear-dev</a><br>
><br>
> _______________________________________________<br>
> aerogear-dev mailing list<br>
> <a href="mailto:aerogear-dev@lists.jboss.org" target="_blank">aerogear-dev@lists.jboss.org</a><br>
> <a href="https://lists.jboss.org/mailman/listinfo/aerogear-dev" target="_blank">https://lists.jboss.org/mailman/listinfo/aerogear-dev</a><br>
<br>
<br>
_______________________________________________<br>
aerogear-dev mailing list<br>
<a href="mailto:aerogear-dev@lists.jboss.org" target="_blank">aerogear-dev@lists.jboss.org</a><br>
<a href="https://lists.jboss.org/mailman/listinfo/aerogear-dev" target="_blank">https://lists.jboss.org/mailman/listinfo/aerogear-dev</a></div></div></blockquote></div><br></div>
</div></div><br>_______________________________________________<br>
aerogear-dev mailing list<br>
<a href="mailto:aerogear-dev@lists.jboss.org" target="_blank">aerogear-dev@lists.jboss.org</a><br>
<a href="https://lists.jboss.org/mailman/listinfo/aerogear-dev" target="_blank">https://lists.jboss.org/mailman/listinfo/aerogear-dev</a><br></blockquote></div><br></div>
<br>_______________________________________________<br>
aerogear-dev mailing list<br>
<a href="mailto:aerogear-dev@lists.jboss.org">aerogear-dev@lists.jboss.org</a><br>
<a href="https://lists.jboss.org/mailman/listinfo/aerogear-dev" target="_blank">https://lists.jboss.org/mailman/listinfo/aerogear-dev</a><br></blockquote></div>