README.md in total-0.3.0 vs README.md in total-0.4.0
- old
+ new
@@ -1,13 +1,19 @@
-[](http://www.elegantobjects.org)
+<img src="/logo.svg" width="64px"/>
+
+[](https://www.0crat.com/p/C3RFVLU72)
+[](https://www.elegantobjects.org)
[](http://www.rultor.com/p/yegor256/total)
-[](https://www.jetbrains.com/ruby/)
+[](https://www.jetbrains.com/ruby/)
-[](https://travis-ci.org/yegor256/total)
+[](https://github.com/yegor256/total/actions/workflows/rake.yml)
[](http://badge.fury.io/rb/total)
[](https://codeclimate.com/github/yegor256/total/maintainability)
[](http://rubydoc.info/github/yegor256/total/master/frames)
+[](https://github.com/yegor256/total/sibit/master/LICENSE.txt)
+[](https://codecov.io/github/yegor256/total?branch=master)
+[](https://hitsofcode.com/view/github/yegor256/total)
Total is a Ruby gem to detect the total amount of memory in the system.
First, install it:
@@ -25,11 +31,11 @@
The following platforms are supported:
* MacOSX
* Linux
* FreeBSD
- * <del>Windows</del> (help needed)
+ * <del>Windows</del> ([help wanted](https://github.com/yegor256/total/issues/3))
If the platform is not recognized or is not supported, `Total::CantDetect` exception
will be raised. You should catch it and proceed accordingly, for example:
```ruby
@@ -43,11 +49,11 @@
This code will return the actual memory size in Mb, if it can be detected,
or 512 otherwise.
That's it.
-# How to contribute
+## How to contribute
Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
Make sure you build is green before you contribute
your pull request. You will need to have [Ruby](https://www.ruby-lang.org/en/) 2.3+ and
[Bundler](https://bundler.io/) installed. Then:
@@ -56,29 +62,5 @@
$ bundle update
$ bundle exec rake
```
If it's clean and you don't see any error messages, submit your pull request.
-
-# License
-
-(The MIT License)
-
-Copyright (c) 2018 Yegor Bugayenko
-
-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.