Add summary, usage info, and missing features to README

Author: nning

README.md

@@ -1,10 +1,13 @@
-# Svelte::Rails
+# Svelte-Rails
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/svelte/rails`. To experiment with that code, run `bin/console` for an interactive prompt.
+Svelte-Rails integrates [Svelte](https://svelte.dev/) with Ruby on Rails. It has the following features:
 
-TODO: Delete this and the text above, and describe your gem
+* Automatically renders Svelte server-side and client-side
+* Supports Webpacker >= 4.2 and Ruby on Rails >= 6
 
-## Installation
+## Usage
+
+Make sure, you have [set-up Webpacker](https://github.com/rails/webpacker#installation) and it's [Svelte integration](https://github.com/rails/webpacker/blob/master/docs/integrations.md#svelte).
 
 Add this line to your application's Gemfile:
 
@@ -15,30 +18,31 @@ gem 'svelte-rails'
 And then execute:
 
     $ bundle install
+    $ rails generate svelte:install
 
-Or install it yourself as:
-
-    $ gem install svelte-rails
-
-## Usage
+An example Rails app with svelte-rails can be seen here:  
+https://github.com/nning/rails-svelte-poc
 
-TODO: Write usage instructions here
+## View Helper
 
-## Development
+```erb
+<%= svelte_component(:Hello, name: 'Svelte') %>
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Missing Features
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+* Better documentation for setup
+* Turbolinks integration
+* Rails generator for initial setup (the previously mentioned line does not work, yet)
+* HMR and Bundle consistency (server-rendered HTML is cached and client-side updates on changes to the sources)
+* Render components directly from controllers
+* Generator for components
+* Render pools
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/svelte-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/svelte-rails/blob/master/CODE_OF_CONDUCT.md).
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/nning/svelte-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/nning/svelte-rails/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Svelte::Rails project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/svelte-rails/blob/master/CODE_OF_CONDUCT.md).