cfc 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40bb48cf72eeb9528ed6c44396499aea91a719845094f1b389a7d891edb64b4c
-  data.tar.gz: f2ffa1a259fdb63166799b050f4035a0023ca9424753336cb21ef4b138ddbc76
+  metadata.gz: 563b2293943b85d67b3dff9d612481addd9dc32272647691d891d3376ccdcf92
+  data.tar.gz: efa22237c80919923fe33a514bbb8779fd9bd9f36d568cf52c56f1f36bf02553
 SHA512:
-  metadata.gz: ae3acc4b662407967520e549a66cd73846ab834a89159d4592a8775af0efccf15ffbdacd09da8464e7f88f3b1a48bf677411614094d5342e95242a795e45b87b
-  data.tar.gz: eccf63a35470b2ee94f33324dd733b1393d43c0e36055840855c711c229b11e708bfae42f50c12443b0a6f6dd8f3b81026bf9fd7c5088996c689afa46ad50458
+  metadata.gz: 9b3de0e73d175282548bbf7c1e67a547d2942285feec299c3cb094af4bb836f10de4814039dc88e7df481b96c4b6a7276b3f559b353abb3b8147aacc12cf7f2f
+  data.tar.gz: 1b709a15c173a3d9b0476469a785e65f90d8d5e0cc76da60f20a34b2f821ae0dc6a4ebf8dba4d515df9c0f70800eef9cdb2c1865d75cc728e72322ca12d23678

data/README.md

@@ -2,17 +2,27 @@
 Simple library for interacting with the Cloudflare API.
 
 ## Install
-Clone the repository. That's it!
+```
+gem install cfc
+```
+
+If you're installing for development/contribution, just clone the repository.
 
 ## Usage
-This library is intended to be very lightweight, to help with usage in quick but effective scripts. Scripts that use
-this library can be added to `scripts/` and run from there—it's *possible* for them to go anywhere, of course,
-but relative `require`s are easier from a proximate directory.
+Once you've `require`d the gem, you _must_ then configure it with required credentials before you can use it. You can do
+this by calling `CFC::Config.configure`, as shown below. You must provide a valid API token for the gem to use in API
+requests.
+
+```ruby
+CFC::Config.configure do |config|
+  config.token = 'your_api_token_here'
+end
+```
 
-You can use the library either by instantiating `CFC::API` and using that class to send API requests directly,
+You can then use the library either by instantiating `CFC::API` and using that class to send API requests directly,
 or, for simpler tasks, you can use pre-provided objects in `lib/objects/`, which represent a data type from the
 Cloudflare API and may provide methods to perform common or simple tasks on those types. See
-`lib/scripts/clear_cache.rb` for an example of how this may be done using `CFC::Zone` objects.
+`lib/scripts/clear_cache.rb` for an example of how this may be done with `CFC::Zone` objects.
 
 ## Contributing
 As with all Codidact projects, contributions are welcome and must adhere to the

data/lib/cfc/version.rb

@@ -1,3 +1,3 @@
 module CFC
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cfc
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - The Codidact Foundation
@@ -10,7 +10,8 @@ bindir: bin
 cert_chain: []
 date: 2020-12-31 00:00:00.000000000 Z
 dependencies: []
-description: 'See GitHub for usage details: https://github.com/codidact/cfc'
+description: 'Simple API library for interacting with the Cloudflare API. See GitHub
+  for usage details: https://github.com/codidact/cfc'
 email: gems@codidact.org
 executables: []
 extensions: []