search

realm / realm-java

Realm is a mobile database: a replacement for SQLite & ORMs
http://realm.io
Apache License 2.0
11.45k stars 1.74k forks source link

Small issue in Readme: Wrong url for SNAPSHOT releases #1881

Closed saket closed 8 years ago

saket commented 8 years ago

Ahoy! The URL for SNAPSHOT releases in the readme file is stale. It points to:

classpath "io.realm:gradle-plugin:<version>-SNAPSHOT"

But the actual URL is:

classpath "io.realm:realm-android:<version>-SNAPSHOT"
mshusek commented 8 years ago

+1 for save me a lot of hours unpleasant surprise

cmelchior commented 8 years ago

Actually we are slowly moving to a new way of deploying Realm which is through a Gradle plugin. The reason for this is that we need to introduce bytecode manipulation to support completely custom methods and fields, so the documentation is accurate albeit missing in detail.

You can see how it is used in our example projects here: https://github.com/realm/realm-java/blob/master/examples/build.gradle and here https://github.com/realm/realm-java/blob/master/examples/introExample/build.gradle

That said, there is actually an error in the description as it should be realm-gradle-plugin instead of gradle-plugin. I'll update the documentation

kneth commented 8 years ago

@cmelchior Please see #1889

saket commented 8 years ago

@cmelchior Oh boy yes! Been waiting for that feature since ages!

saket commented 8 years ago

Noob question, is there a difference between these two Realms:

io.realm:realm-gradle-plugin:<version>-SNAPSHOT

io.realm:realm-android:<version>-SNAPSHOT
cmelchior commented 8 years ago

Yes, the first is our Gradle plugin which requires the setup I mentioned. The later is our "FatJar" that doesn't depend on the Gradle plugin, but cannot do bytecode manipulation when we introduce it. This is what people are currently using.

For now they are functional equivalent (but require slightly different setup in the build.gradle files)

saket commented 8 years ago

Got it!