README.md in lolp-0.1.0 vs README.md in lolp-0.2.0
- old
+ new
@@ -1,8 +1,9 @@
-# Lolp.rb
+<p align="center"><img src="https://raw.githubusercontent.com/pepabo/lolp.rb/images/lolipop-logo-by-gmo-pepabo.png" width="300" alt="lolp" /></p><p align="center"><strong>lolp</strong>: Simple ruby wrapper for Lolipop! API.</p> <br /> <br />
-Simple ruby wrapper for Lolipop! API.
+[](https://rubygems.org/gems/lolp)
+[](https://travis-ci.org/pepabo/lolp.rb)
## Installation
Add this line to your application's Gemfile:
@@ -18,17 +19,33 @@
$ gem install lolp
## Usage
-TODO: Write usage instructions here
+```ruby
+Lolp.configure do |config|
+ config.api_endpoint = 'LOLIPOP MC API ENDPOINT'
+ config.username = 'LOLIPOP MC USERNAME'
+ config.password = 'LOLIPOP MC PASSWORD'
+end
+```
+### Projects
+
+```ruby
+Lolp.projects
+Lolp.create_project(:rails) # :wordpress, :php, ...
+Lolp.delete_project('jungly-naha-2778')
+Lolp.create_custom_domain('jungly-naha-2778.lolipop.ohr','example.com')
+Lolp.delete_custom_domain('jungly-naha-2778.lolipop.ohr','example.com')
+```
+
## Development
After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
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).
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/linyows/lolp.
+Bug reports and pull requests are welcome on GitHub at https://github.com/pepabo/lolp.rb.