From 3f6f79c111ae3cd82138bc5c61ebb5b02f7b45b4 Mon Sep 17 00:00:00 2001 From: Sebastian Kippe Date: Wed, 4 Jul 2018 08:51:13 +0200 Subject: [PATCH] Make README useful closes #2 --- README.md | 47 ++++++++++++++++++++++++++++++----------------- 1 file changed, 30 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 02438fb..25ca7a3 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,14 @@ # Manifique -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/manifique`. To experiment with that code, run `bin/console` for an -interactive prompt. - -TODO: Delete this and the text above, and describe your gem +Manifique fetches metadata of Web applications, like e.g. name, description, +and app icons. It prefers information from Web App Manifest files, and falls +back to parsing HTML if necessary. ## Installation Add this line to your application's Gemfile: -```ruby gem 'manifique' ``` +```gem 'manifique'``` And then execute: @@ -23,13 +20,27 @@ Or install it yourself as: ## Usage -TODO: Write usage instructions here +First, initialize a Manifique agent for the web app you want to get metadata +for. Its URL is the only required argument: + +```ruby +agent = Manifique::Agent.new(url: "https://kosmos.social") +``` + +Now you can fetch its metadata: + +```ruby +puts agent.fetch_metadata +``` ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run -`rake test` to run the tests. You can also run `bin/console` for an interactive -prompt that will allow you to experiment. +`rake spec` to run the specs once, or `bundle exec guard` to watch all source +files and run their specs automatically. + +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 @@ -40,17 +51,19 @@ git commits and tags, and push the `.gem` file to ## Contributing Bug reports and pull requests are welcome on GitHub at -https://github.com/skddc/manifique. This project is intended to be a safe, -welcoming space for collaboration, and contributors are expected to adhere to -the [Contributor Covenant](http://contributor-covenant.org) code of conduct. +https://github.com/5apps/manifique. Please add specs for any changes or +additions. ## License -The gem is available as open source under the terms of the [MIT -License](https://opensource.org/licenses/MIT). +The gem is available as open source under the terms of the [AGPL +3](https://opensource.org/licenses/AGPL-3.0). + +TL;DR: if you use this gem in a project, the entire project's source has to be +made available as open source. ## Code of Conduct -Everyone interacting in the Manifique project’s codebases, issue trackers, chat -rooms and mailing lists is expected to follow the [code of +Everyone interacting in this project’s codebase, issue trackers, and chat +rooms is expected to follow the [code of conduct](https://github.com/skddc/manifique/blob/master/CODE_OF_CONDUCT.md).