README.markdown in spotify-12.3.0 vs README.markdown in spotify-12.4.0
- old
+ new
@@ -15,34 +15,35 @@
The Spotify gem has:
- [100% API coverage][], including callback support. You’ll be able to use any function from the libspotify library.
- [Automatic garbage collection][]. Piggybacking on Ruby’s GC to manage pointer lifecycle.
- [Parallell function call protection][]. libspotify is not thread-safe, but Spotify protects you.
-- [Type conversion][]. Special pointers for every Spotify type.
+- [Type conversion and type safety][]. Special pointers for every Spotify type, protecting you from accidental mix-ups.
[100% API coverage]: http://rdoc.info/github/Burgestrand/spotify/master/Spotify/API
[Automatic garbage collection]: http://rdoc.info/github/Burgestrand/spotify/master/Spotify/ManagedPointer
[Parallell function call protection]: http://rdoc.info/github/Burgestrand/spotify/master/Spotify#method_missing-class_method
-[Type conversion]: http://rdoc.info/github/Burgestrand/spotify/master/Spotify/ManagedPointer
+[Type conversion and type safety]: http://rdoc.info/github/Burgestrand/spotify/master/Spotify/ManagedPointer
The Spotify gem is aimed at experienced developers
--------------------------------------------------
As the raw libspotify API is exposed, the Spotify gem is best coupled with a supporting
library. This library would take a more focused approach to which kind of applications
you can write using it. The Spotify gem itself, however, has very few opinions.
Known supporting libraries:
-- [Hallon](https://github.com/Burgestrand/Hallon), the original. Currently Hallon is simply
- a more convenient Spotify gem, written on top of the Spotify gem. It is diverging from its
- previous path, now towards a more focused and opinionated framework. If you’re unsure of
- what to use, start with the Hallon gem!
+- [Hallon](https://github.com/Burgestrand/Hallon). Hallon attempted to be a one-gem-does-all,
+ at a higher abstraction level than the Spotify gem. It features a slightly more convenient
+ API for certain things, and requires no ruby FFI knowledge, but it is not really an expert
+ on any use case.
-Do not let this stop you! Despite my harsh words the Spotify API is well suited for experimentation,
-and it can be awfully fun to play with. If you need any assitance feel free to post a message
-on the mailing list: [ruby-hallon@googlegroups.com][] (<https://groups.google.com/d/forum/ruby-hallon>).
+The Spotify API is well suited for experimentation, and it can be awfully fun to play with.
+The examples/ directory contains example code for achieving certain tasks with the Spotify gem.
+If you need any assitance feel free to post a message on the mailing list: [ruby-hallon@googlegroups.com][].
+
Manually installing libspotify
------------------------------
By default, Spotify uses [the libspotify gem](https://rubygems.org/gems/libspotify) which means you do
not need to install libspotify yourself. However, if your platform is not supported by the libspotify
gem you will need to install libspotify yourself.
@@ -61,10 +62,28 @@
- X reflects supported libspotify version (12.1.45 => 12). There are __no guarantees__ of backwards-compatibility!
- Y(major).Z(minor) follows [semantic versioning (semver.org)][]. Y is for backwards-**incompatible** changes, Z is for backwards-**compatible** changes.
License
-------
-X11 license, see the LICENSE document for details.
+Copyright (c) 2012 Kim Burgestrand <kim@burgestrand.se>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
[semantic versioning (semver.org)]: http://semver.org/
[ruby-hallon@googlegroups.com]: mailto:ruby-hallon@googlegroups.com
[libspotify]: http://developer.spotify.com/en/libspotify/overview/
[Spotify]: https://www.spotify.com/