5apps/manifique
5apps/manifique
4
0
Fork 0
Code Issues Pull Requests Releases 3 Activity

Make README useful

Browse Source 
closes #2
This commit is contained in:
Basti 2018-07-04 08:51:13 +02:00
parent 14b1f5befe
commit 3f6f79c111
1 changed files with 30 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -1,17 +1,14 @@
# Manifique # Manifique
Welcome to your new gem! In this directory, you'll find the files you need to Manifique fetches metadata of Web applications, like e.g. name, description,
be able to package up your Ruby library into a gem. Put your Ruby code in the and app icons. It prefers information from Web App Manifest files, and falls
file `lib/manifique`. To experiment with that code, run `bin/console` for an back to parsing HTML if necessary.
interactive prompt.
TODO: Delete this and the text above, and describe your gem
## Installation ## Installation
Add this line to your application's Gemfile: Add this line to your application's Gemfile:
```ruby gem 'manifique' ``` ```gem 'manifique'```
And then execute: And then execute:
@ -23,13 +20,27 @@ Or install it yourself as:
## Usage ## 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 ## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run 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 `rake spec` to run the specs once, or `bundle exec guard` to watch all source
prompt that will allow you to experiment. 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 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 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 ## Contributing
Bug reports and pull requests are welcome on GitHub at Bug reports and pull requests are welcome on GitHub at
https://github.com/skddc/manifique. This project is intended to be a safe, https://github.com/5apps/manifique. Please add specs for any changes or
welcoming space for collaboration, and contributors are expected to adhere to additions.
the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License ## License
The gem is available as open source under the terms of the [MIT The gem is available as open source under the terms of the [AGPL
License](https://opensource.org/licenses/MIT). 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 ## Code of Conduct
Everyone interacting in the Manifique project’s codebases, issue trackers, chat Everyone interacting in this project’s codebase, issue trackers, and chat
rooms and mailing lists is expected to follow the [code of rooms is expected to follow the [code of
conduct](https://github.com/skddc/manifique/blob/master/CODE_OF_CONDUCT.md). conduct](https://github.com/skddc/manifique/blob/master/CODE_OF_CONDUCT.md).