aesteve / nubes

Annotation layer on top of Vert.x 3
Apache License 2.0
120 stars 35 forks source link

improve readme #52

Open villesau opened 8 years ago

villesau commented 8 years ago

i noticed the readme lacks the instructions like how to get the nubes, how to run the server etc. I didn't find nubes from maven or anywhere. vertx-jersey has a good starter guide here: https://github.com/englishtown/vertx-jersey i was almost going with that until i noticed how terrible their api is compared to yours. to get more hype, starting with the framework has to be as easy as possible so more people would give it a try :)

aesteve commented 8 years ago

You're completely right.

To be honest, I was waiting 3.2.0 to add an OAuth2 annotation then release Nubes 1.0.

So for now, it's absolutely normal that you can't find it anywhere.

Christmas holidays are close :)

It'll let me some type to finalize the 1.0 release (and push it to bintray).

If you're not afraid (or really in a hurry !) and are channeling the soul of an early adopter, you can still clone the project and install it to your local maven repo :

git clone https://github.com/aesteve/nubes.git cd nubes ./gradlew install

Or you can wait ~1 week.

Thanks for your comment :)

aesteve commented 8 years ago

1.0 has been released to jcenter. Could you tell me what you need to help you getting started, what are you looking for exactly ?

It's pretty hard for me to see Nubes from an external point of view. I'd be happy to :

Just tell me :)