doc/README_md.html in strongdm-1.0.7 vs doc/README_md.html in strongdm-1.0.8
- old
+ new
@@ -59,11 +59,16 @@
<div class="nav-section">
<h3>Table of Contents</h3>
<ul class="link-list" role="directory">
<li><a href="#label-strongDM+SDK+for+Ruby">strongDM SDK for Ruby</a>
- <li><a href="#label-Quick+Start">Quick Start</a>
+ <li><a href="#label-Installation">Installation</a>
+ <li><a href="#label-Authentication">Authentication</a>
+ <li><a href="#label-List+Users">List Users</a>
+ <li><a href="#label-Useful+Links">Useful Links</a>
+ <li><a href="#label-License">License</a>
+ <li><a href="#label-Contributing">Contributing</a>
</ul>
</div>
<div id="project-metadata">
@@ -76,61 +81,67 @@
<li><a href="./README_md.html">README</a>
<li><a href="./examples/Gemfile.html">Gemfile</a>
- <li><a href="./examples/Gemfile_lock.html">Gemfile.lock</a>
-
- <li><a href="./examples/README_md.html">README</a>
-
- <li><a href="./examples/okta-sync/Gemfile.html">Gemfile</a>
-
- <li><a href="./examples/okta-sync/Gemfile_lock.html">Gemfile.lock</a>
-
<li><a href="./lib/version.html">version</a>
- <li><a href="./strongdm_gemspec.html">strongdm.gemspec</a>
-
</ul>
</div>
</div>
</nav>
<main role="main" aria-label="Page README.md">
<h1 id="label-strongDM+SDK+for+Ruby">strongDM SDK for Ruby<span><a href="#label-strongDM+SDK+for+Ruby">¶</a> <a href="#top">↑</a></span></h1>
-<p>The official strongDM SDK for the Ruby programming language.</p>
+<p>This is the official <a href="https://www.strongdm.com/">strongDM</a> SDK for the Ruby programming language.</p>
-<h2 id="label-Quick+Start">Quick Start<span><a href="#label-Quick+Start">¶</a> <a href="#top">↑</a></span></h2>
+<h2 id="label-Installation">Installation<span><a href="#label-Installation">¶</a> <a href="#top">↑</a></span></h2>
-<p>First, install the gem:</p>
-
<pre>$ gem install strongdm</pre>
-<p>Next, go to <a href="https://app.strongdm.com">app.strongdm.com</a> and create an API key. Set the <code>SDM_API_ACCESS_KEY</code> and <code>SDM_API_SECRET_KEY</code> environment variables.</p>
+<h2 id="label-Authentication">Authentication<span><a href="#label-Authentication">¶</a> <a href="#top">↑</a></span></h2>
-<pre>$ export SDM_API_ACCESS_KEY=<YOUR ACCESS KEY>
-$ export SDM_API_SECRET_KEY=<YOUR SECRET KEY></pre>
+<p>If you don't already have them you will need to generate a set of API keys, instructions are here: <a href="https://www.strongdm.com/docs/admin-guide/api-credentials/">API Credentials</a></p>
-<p>Run some example code.</p>
+<p>Add the keys as environment variables; the SDK will need to access these keys for every request. <code>bash $ export SDM_API_ACCESS_KEY=<YOUR ACCESS KEY> $ export SDM_API_SECRET_KEY=<YOUR SECRET KEY> </code></p>
+<h2 id="label-List+Users">List Users<span><a href="#label-List+Users">¶</a> <a href="#top">↑</a></span></h2>
+
+<p>The following code lists all registered users:</p>
+
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">"strongdm"</span>
<span class="ruby-identifier">client</span> = <span class="ruby-constant">SDM</span><span class="ruby-operator">::</span><span class="ruby-constant">Client</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-string">'SDM_API_ACCESS_KEY'</span>], <span class="ruby-constant">ENV</span>[<span class="ruby-string">'SDM_API_SECRET_KEY'</span>])
<span class="ruby-identifier">users</span> = <span class="ruby-identifier">client</span>.<span class="ruby-identifier">accounts</span>.<span class="ruby-identifier">list</span>(<span class="ruby-string">''</span>)
<span class="ruby-identifier">users</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">user</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">p</span> <span class="ruby-identifier">user</span>
<span class="ruby-keyword">end</span>
</pre>
+<h2 id="label-Useful+Links">Useful Links<span><a href="#label-Useful+Links">¶</a> <a href="#top">↑</a></span></h2>
+<ul><li>
+<p>Documentation: <a href="https://www.rubydoc.info/gems/strongdm">strongdm gem</a></p>
+</li><li>
+<p>Examples: <a href="https://github.com/strongdm/strongdm-sdk-ruby-examples">GitHub - strongdm/strongdm-sdk-ruby-examples</a> 1. <a href="https://github.com/strongdm/strongdm-sdk-ruby-examples/tree/master/1_managing_resources">Managing Resources</a> 2. <a href="https://github.com/strongdm/strongdm-sdk-ruby-examples/tree/master/2_managing_accounts">Managing Accounts</a> 3. <a href="https://github.com/strongdm/strongdm-sdk-ruby-examples/tree/master/3_managing_roles">Managing Roles</a> 4. <a href="https://github.com/strongdm/strongdm-sdk-ruby-examples/tree/master/4_managing_gateways">Managing Gateways</a></p>
+</li></ul>
+
+<h2 id="label-License">License<span><a href="#label-License">¶</a> <a href="#top">↑</a></span></h2>
+
+<p><a href="https://github.com/strongdm/strongdm-sdk-ruby/blob/master/LICENSE">Apache 2</a></p>
+
+<h2 id="label-Contributing">Contributing<span><a href="#label-Contributing">¶</a> <a href="#top">↑</a></span></h2>
+
+<p>Currently, we are not accepting pull requests directly to this repository, but our users are some of the most resourceful and ambitious folks out there. So, if you have something to contribute, find a bug, or just want to give us some feedback, please email <a href="mailto:support@strongdm.com">support@strongdm.com</a>.</p>
+
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>