lcclasses 0.2.0 → 0.2.1

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.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/README.md +20 -3
  4. data/lcclasses.gemspec +1 -1
  5. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 49b2f5106b678c366efacf049369567d895f1e9869db97cdd476b06b02791adb
4
- data.tar.gz: 8e5ac470b862993e636db8a97980b83e4773f6fdc3ce4af3bf0b8285291ef840
3
+ metadata.gz: aeb1be10398c6a7df915eabef2cdf1c5c7890bb22c4c2965b43c59579798a2d5
4
+ data.tar.gz: 7d735aa81881f9c168adabd80ff755109ea71407bb23a071771a1d9f9ea0df38
5
5
  SHA512:
6
- metadata.gz: fa3770b6bb17e9002932fccd05eb5154fa4a2b8b79c60c47adf42a5484280021753a41da01a07612fed8257670f60863fc336a9afee384bc5cfd9b318f04e9ec
7
- data.tar.gz: bdcda9e0a43f8e36257d16b2b5434eb5a6416eaeda132d7172f32c9a1f238ba9b171ac10df807b5ba3b9bcac062eb9bf01f9e953a6e9800154994315a3eccc6e
6
+ metadata.gz: 6baebb79f8ae80af160ddc4fa9c7f712f5f44033721b4fd6e15e3044baf48aac285aba7ba80f627c97e80763ef9ef8ee3a5644f0acb46ba7be89b35cf4709e2d
7
+ data.tar.gz: 42c3ed50be9477705a09a5e06d8cb290cf62c43321ad50fe1394e3fdc188f0313b8cdc115d0bc8ba1245faf42f0651a7c3d968f05cd9bc7917df8a260a0f0429
data/.gitignore CHANGED
@@ -6,3 +6,4 @@ pkg
6
6
  .rvmrc
7
7
  .ruby-version
8
8
  .bundle
9
+ *.gem
data/README.md CHANGED
@@ -1,13 +1,26 @@
1
1
  # LCCLasses
2
2
 
3
- A Ruby gem that provides the Library of Congress Classification system main classes and subclasses along with some convenience methods.
3
+ A Ruby gem that provides the
4
+ [Library of Congress Classification](https://www.loc.gov/catdir/cpso/lcc.html)
5
+ system main classes and subclasses along with some convenience methods.
4
6
 
5
- To install:
7
+ ## Installation
8
+
9
+ LCCLasses is available on [RubyGems](https://rubygems.org/gems/lcclasses):
6
10
 
7
11
  ```bash
8
12
  gem install lcclasses
9
13
  ```
10
14
 
15
+ To install with [Bundler](https://bundler.io/), add the following to your
16
+ Gemfile:
17
+
18
+ ```ruby
19
+ gem 'lcclasses'
20
+ ```
21
+
22
+ Then run `bundle install`
23
+
11
24
  ## Usage
12
25
 
13
26
  To find a classification code:
@@ -48,7 +61,11 @@ The `CLASS_HASH` constant is in the following format (truncated example):
48
61
  }
49
62
  ```
50
63
 
51
- Classes are returned as specialized LCClasses::Class arrays in the format `[code, name]`. In the case of nested LCClasses:LCClass objects, they are in the format `[main_class_code, main_class_name, [[subclass_code, subclass_name]]]`. These objects are normal arrays with the following methods added:
64
+ Classes are returned as specialized LCClasses::Class arrays in the format
65
+ `[code, name]`. In the case of nested LCClasses:LCClass objects, they are in
66
+ the format
67
+ `[main_class_code, main_class_name, [[subclass_code, subclass_name]]]`.
68
+ These objects are normal arrays with the following methods added:
52
69
 
53
70
  ```ruby
54
71
  @class = LCClasses.find_main_class_by_code("M")
@@ -2,7 +2,7 @@
2
2
 
3
3
  Gem::Specification.new do |s|
4
4
  s.name = 'lcclasses'
5
- s.version = '0.2.0'
5
+ s.version = '0.2.1'
6
6
  s.licenses = ['MIT']
7
7
  s.summary = 'Library of Congress Classification classes and subclasses.'
8
8
  s.description = 'Library of Congress Classification classes and subclasses.'
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: lcclasses
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ version: 0.2.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - William Melody