typekit_domain_manager 0.1.0.pre → 0.1.0

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 (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +25 -7
  3. data/lib/typekit_domain_manager/version.rb +1 -1
  4. metadata +4 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 250511d20c459f9713def6ea30e13674eb01dafe
4
- data.tar.gz: 62effb0157ae037c50619322bdfebef3d7e9ad64
3
+ metadata.gz: 478cec2c00db8bfdf088beaa2bd8477c8b6a75b2
4
+ data.tar.gz: ceb2452ada8c141fd4b23e6b77c80dd8a44a47cb
5
5
  SHA512:
6
- metadata.gz: 16360258ea2777ee08256931f73f2475c2017562fda9007279e9f7c428afdd23a0c4c33ce308871ec5650eb2ce5c0f004439b027b971f439e08249efa6295733
7
- data.tar.gz: 10745e1c005e757c6c0c1e5d5293f9c44a8048b7039fe33bb772a73362087b884e8e172137bbe0598a8de274e3e275bfb8529129f3f1f8c962351091d6594809
6
+ metadata.gz: bc43ebc91d4a09eb24d02cbc7ce516874fd9aec1f4b273b7b4a1b4d03496d4390dfd8c4c42d2311d9fa3e37e1e9a5df250a971e84062a8f07e80e3d32d1cb775
7
+ data.tar.gz: fdb6808dda0a7a1663905bbb5bb1857dce64ef12698fa10aad7c0634049ca19629db032b0f119bc29c44b6832345f77702be01e14b7623b8a011bb839f3e1d88
data/README.md CHANGED
@@ -1,8 +1,6 @@
1
- # TypekitDomainManager
1
+ # TypeKit Domain Manager
2
2
 
3
- 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/typekit_domain_manager`. To experiment with that code, run `bin/console` for an interactive prompt.
4
-
5
- TODO: Delete this and the text above, and describe your gem
3
+ Provides an easy interface to dynamically manage TypeKit domain whitelists.
6
4
 
7
5
  ## Installation
8
6
 
@@ -22,7 +20,28 @@ Or install it yourself as:
22
20
 
23
21
  ## Usage
24
22
 
25
- TODO: Write usage instructions here
23
+ TypeKit Domain Manager is made up of a single class and three methods. It's very easy to interact with:
24
+
25
+ ```ruby
26
+ typekit_api_key = 'your typekit api key'
27
+ typekit_kit_id = 'your typekit kit id'
28
+
29
+ # Create a new instance of the domain manager
30
+ domain_manager = TypekitDomainManager::Kit.new typekit_api_key, typekit_kit_id
31
+
32
+ # Add a new domain to the whitelist
33
+ domain_manager.add_domain 'example.com'
34
+
35
+ # Remove a domain from the whitelist
36
+ domain_manager.remove_domain 'example.com'
37
+
38
+ # Get a list of domains
39
+ domain_manager.get_domains
40
+ ```
41
+
42
+ That's all there is to it. If you hit any snags, please do open an issue or submit a pull request.
43
+
44
+ Head over to the [TypeKit site for an API key](https://typekit.com/account/tokens), and visit the 'Settings' screen for a kit to get its ID.
26
45
 
27
46
  ## Development
28
47
 
@@ -32,10 +51,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
32
51
 
33
52
  ## Contributing
34
53
 
35
- Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/typekit_domain_manager. 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.
54
+ Bug reports and pull requests are welcome on GitHub at https://github.com/danielgroves/typekit_domain_manager. 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.
36
55
 
37
56
 
38
57
  ## License
39
58
 
40
59
  The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
41
-
data/lib/typekit_domain_manager/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module TypekitDomainManager
2
- VERSION = "0.1.0.pre"
2
+ VERSION = "0.1.0"
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: typekit_domain_manager
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0.pre
4
+ version: 0.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Daniel Groves
@@ -85,12 +85,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
85
85
  version: '0'
86
86
  required_rubygems_version: !ruby/object:Gem::Requirement
87
87
  requirements:
88
- - - ">"
88
+ - - ">="
89
89
  - !ruby/object:Gem::Version
90
- version: 1.3.1
90
+ version: '0'
91
91
  requirements: []
92
92
  rubyforge_project:
93
- rubygems_version: 2.4.6
93
+ rubygems_version: 2.5.1
94
94
  signing_key:
95
95
  specification_version: 4
96
96
  summary: Easy domain control for TypeKit Kits.