ruby_doc 1.0.2 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +63 -8
- data/lib/ruby_doc/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: bea0d19c697dddd4a4a635c8ca69683c4b4567e6da992835d3cb376164f5aacf
|
|
4
|
+
data.tar.gz: c25bc2211e0be444657bbc1dcc5cc2d35a1e0772151219483e5f23e1d98d4321
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 380b83296bc8a1bcf5edf9b6bc326403432fc6add4a6ba2557ac3432005fe542e60d22140f7d94e317cb096e30ab35658b7694ccfd5cbc7b4bbb0f4326293383
|
|
7
|
+
data.tar.gz: 9313cd4ac4162cb14cc52655e969f76ab4dcb8e3336c65e982bd96dc157c31c903675e38cf46f380dd2c9cfe5d757818765a633ec7fe381b607bc559bf11e7d5
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -1,18 +1,73 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ALPHA RUBY DOC
|
|
2
2
|
[](http://forthebadge.com)
|
|
3
3
|
[](http://forthebadge.com)
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## A CLI Gem That Scrapes Ruby Documentation
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
<img src="https://i.imgur.com/AeHWQj8.gif" alt="image" width="790" height="170">
|
|
7
|
+
|
|
9
8
|
|
|
10
|
-
|
|
11
|
-
|
|
9
|
+
Ever get tired of leaving your editor / environment to google a method, or more in depth info on a class or module? This gem aims to make Ruby referencing quick and more importantly, **LOCAL!**
|
|
10
|
+
|
|
11
|
+
**Alpha Ruby Doc** scrapes Ruby documentation and allows users to quickly reference Ruby methods and additional information all on your terminal. Have a query? **Run, Hunt, and Done**. Never lose momentum, keep all things in your line of sight, and get right back to coding!
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
## A Look Inside
|
|
15
|
+
[](http://forthebadge.com)
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
### Features
|
|
19
|
+
* Search by name
|
|
20
|
+
* View related methods
|
|
21
|
+
* Browse all Docs (Paginated Output To Terminal)
|
|
22
|
+
* Source Links
|
|
23
|
+
* Easy Navigation (Back To Main On Every Menu)
|
|
24
|
+
* Random Dev Quotes (Ok This One Is Just For Fun Lol)
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
## INSTALLATION
|
|
28
|
+
|
|
29
|
+
<img src="https://i.imgur.com/AeHWQj8.gif" alt="image" width="790" height="170" align="middle">
|
|
30
|
+
|
|
31
|
+
#### JUST KIDDING
|
|
32
|
+
[](http://forthebadge.com)
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
#### For Your Application:
|
|
36
|
+
|
|
37
|
+
Add this line to your application's Gemfile
|
|
38
|
+
|
|
39
|
+
```ruby
|
|
40
|
+
gem 'ruby_doc'
|
|
12
41
|
```
|
|
13
42
|
|
|
14
|
-
|
|
43
|
+
And then execute
|
|
44
|
+
|
|
45
|
+
$ bundle
|
|
46
|
+
|
|
47
|
+
#### For Yourself:
|
|
48
|
+
|
|
49
|
+
$ gem install ruby_doc
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
## USAGE
|
|
54
|
+
|
|
55
|
+
Once installed execute
|
|
56
|
+
|
|
57
|
+
$ ruby_doc
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
## Contributing
|
|
61
|
+
|
|
62
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/AlphaDaniel/alpha-ruby_doc. 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.
|
|
63
|
+
|
|
64
|
+
## License
|
|
65
|
+
|
|
66
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
|
67
|
+
|
|
68
|
+
## Code of Conduct
|
|
69
|
+
|
|
70
|
+
Everyone interacting in the AlphaRefRuby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ruby_doc/blob/master/CODE_OF_CONDUCT.md).
|
|
15
71
|
|
|
16
|
-
|
|
17
72
|
|
|
18
73
|
|
data/lib/ruby_doc/version.rb
CHANGED