index.html

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>Cely</title>

  <!-- Google / Search Engine Tags -->
  <meta itemprop="name" content="Cely">
  <meta itemprop="image" content="./images/CelyLogo_beta.png">

  <!-- Facebook Meta Tags -->
  <meta property="og:url" content="https://www.celylog.in">
  <meta property="og:type" content="website">
  <meta property="og:title" content="Cely">
  <meta property="og:description" content="Plug-n-Play login framework written in Swift">
  <meta property="og:image" content="./images/CelyLogo_beta.png">

  <!-- Twitter Meta Tags -->
  <meta name="twitter:card" content="summary_large_image">
  <meta name="twitter:title" content="Cely">
  <meta name="twitter:description" content="Plug-n-Play login framework written in Swift">
  <meta name="twitter:image" content="./images/CelyLogo_beta.png">

  <meta name="description" content="Plug-n-Play login framework written in Swift">
  <meta name="author" content="Cely Team">
  <link rel="canonical" href="https://www.celylog.in/">
  <link rel="shortcut icon" href="img/favicon.ico">
  <title>Cely</title>
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700" />

  <link rel="stylesheet" href="css/theme.css" />
  <link rel="stylesheet" href="css/theme_extra.css" />
  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" />
  
  <script>
    // Current page data
    var mkdocs_page_name = "Home";
    var mkdocs_page_input_path = "index.md";
    var mkdocs_page_url = "/";
  </script>
  
  <script src="js/jquery-2.1.1.min.js"></script>
  <script src="js/modernizr-2.8.3.min.js" defer></script>
  <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
  <script>hljs.initHighlightingOnLoad();</script> 
  
</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
    <div class="wy-side-scroll">
      <div class="wy-side-nav-search">
        <a href=".">
          <img src="./images/CelyLogo_beta.png" />
        </a>
        <div role="search">
  <form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" title="Type search term here" />
  </form>
</div>
      </div>

      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
                <ul >
                    <li class="toctree-l1"><a class="reference internal" href="includes/installing-cely/">Installation</a>
    <ul >
    <li class="toctree-l2"><a class="reference internal" href="includes/installing-cely/#carthage">Carthage</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="includes/installing-cely/#cocoapods">CocoaPods</a>
    </li>
    </ul>
                    </li>
                </ul>
                <p class="caption"><span class="caption-text">Usage</span></p>
                <ul >
                    <li class="toctree-l1"><a class="reference internal" href="usage/basic_usage/">Basic</a>
    <ul >
    <li class="toctree-l2"><a class="reference internal" href="usage/basic_usage/#introduction">Introduction</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="usage/basic_usage/#cely-setup">Cely Setup</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="usage/basic_usage/#save-credentials">Save Credentials</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="usage/basic_usage/#code">Code:</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="usage/basic_usage/#whats-next">What's next?</a>
    </li>
    </ul>
                    </li>
                    <li class="toctree-l1"><a class="reference internal" href="usage/advance_usage/">Advance</a>
    <ul >
    </ul>
                    </li>
                </ul>
                <p class="caption"><span class="caption-text">Guides</span></p>
                <ul >
                    <li class="toctree-l1"><a class="reference internal" href="guides/understanding_keychain/">Understanding Keychain</a>
    <ul >
    <li class="toctree-l2"><a class="reference internal" href="guides/understanding_keychain/#introduction">Introduction</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="guides/understanding_keychain/#keychain-anatomy">Keychain Anatomy</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="guides/understanding_keychain/#keychain-operations">Keychain Operations</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="guides/understanding_keychain/#accessibility">Accessibility</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="guides/understanding_keychain/#add-faceidtouchid">Add FaceID/TouchID</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="guides/understanding_keychain/#common-errors">Common Errors</a>
    </li>
    </ul>
                    </li>
                </ul>
                <p class="caption"><span class="caption-text">API Reference</span></p>
                <ul >
                    <li class="toctree-l1"><a class="reference internal" href="api/cely/">Cely</a>
    <ul >
    <li class="toctree-l2"><a class="reference internal" href="api/cely/#setup_">setup(_:)</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="api/cely/#changestatus_">changeStatus(_:)</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="api/cely/#get_-gt-any">get(_:) -&gt; Any?</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="api/cely/#save_-gt-result">save(_:) -&gt; Result</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="api/cely/#currentloginstatus-gt-celystatus">currentLoginStatus() -&gt; CelyStatus</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="api/cely/#logout_">logout(_:)</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="api/cely/#isloggedin-gt-bool">isLoggedIn() -&gt; Bool</a>
    </li>
    </ul>
                    </li>
                    <li class="toctree-l1"><a class="reference internal" href="api/cely-credentials/">Cely Credentials</a>
    <ul >
    <li class="toctree-l2"><a class="reference internal" href="api/cely-credentials/#set_-gt-result">set(_:) -&gt; Result</a>
    </li>
    <li class="toctree-l2"><a class="reference internal" href="api/cely-credentials/#get-gt-result">get() -&gt; Result</a>
    </li>
    </ul>
                    </li>
                    <li class="toctree-l1"><a class="reference internal" href="api/protocols/">Protocols</a>
    <ul >
    </ul>
                    </li>
                    <li class="toctree-l1"><a class="reference internal" href="api/constants/">Constants</a>
    <ul >
    </ul>
                    </li>
                </ul>
      </div>
    </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href=".">Cely</a>
      </nav>

      
      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href=".">Docs</a> &raquo;</li>
    
      
    
    <li>Home</li>
    <li class="wy-breadcrumbs-aside">
      
        <a href="https://github.com/cely-tools/docs/edit/master/docs/index.md"
          class="icon icon-github"> Edit on GitHub</a>
      
    </li>
  </ul>
  
  <hr/>
</div>
          <div role="main">
            <div class="section">
              
                <div style="text-align:center">
  <img src="images/READMEHeader.png" />
  <img src="images/background_cely_login.gif" />
  <br/>
  <br/>
   <img src="https://img.shields.io/badge/Swift-3.0-orange.svg?style=flat"/>
    <a href="https://github.com/Carthage/Carthage">
      <img
        src="https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat"
        alt="Carthage compatible"/>
    </a>
    <a href="https://cocoapods.org/pods/Cely">
      <img
        src="https://img.shields.io/cocoapods/v/Cely.svg"
        alt="CocoaPods compatible"/>
    </a>
    <a href="http://github.com/cookiecutter-swift/Framework">
      <img
        src="https://img.shields.io/badge/cookiecutter--swift-framework-red.svg"
        alt="Cookiecutter-Swift"/>
    </a>
    <a href="https://app.bitrise.io/app/aff729145cb46dfe">
      <img
        src="https://app.bitrise.io/app/aff729145cb46dfe/status.svg?token=YUV0bymd7P_w2tdiKw2xOQ&branch=master"
        alt="Build Status"/>
    </a>
    <a href="https://codecov.io/gh/initFabian/Cely">
      <img
        src="https://codecov.io/gh/initFabian/Cely/branch/master/graph/badge.svg"
        alt="codecov"/>
    </a>
</div>

<p><br/></p>
<h2 id="why-cely">Why Cely<a class="headerlink" href="#why-cely" title="Permanent link">#</a></h2>
<p>Cely's goal is to add a secure login system into your app in under 30 seconds!</p>
<h3 id="background">Background<a class="headerlink" href="#background" title="Permanent link">#</a></h3>
<p>Most applications that work with <a href="https://developer.apple.com/documentation/security/keychain_services">Keychain Services</a>, use it to store sensitive information such as user credentials and tokens. When working with Keychain, you typically would find yourself using a framework like <a href="https://github.com/kishikawakatsumi/KeychainAccess">KeychainAccess</a>, <a href="https://github.com/matthewpalmer/Locksmith">Locksmith</a>, or <a href="https://github.com/evgenyneu/keychain-swift">keychain-swift</a>. Even tutorials from some of the most reputable online resources encourage the use of these frameworks. Even Apple provides a <a href="https://developer.apple.com/library/archive/samplecode/GenericKeychain/Introduction/Intro.html#//apple_ref/doc/uid/DTS40007797-Intro-DontLinkElementID_2">wrapper</a> around keychain.</p>
<p>This is no coincidence either, Keychain Service is apart of Apple's lower level <a href="https://developer.apple.com/documentation/security">Security Framework</a> which is written in C. I too would encourage you to use a framework instead of interfacing with this API directly. There's no need to reinvent the wheel when working with this API. But if you must, I suggest you bookmark <a href="https://www.osstatus.com/search/results?platform=all&amp;framework=Security&amp;search=#">osstatus.com</a> to help you decipher all the possible <code>OSStatus</code> error codes your app will encounter.</p>
<p>But <strong>storing information securely is only one half of the solution</strong>, the <strong>other half is building a Login system</strong>. This Login system will be an entirely different part of your codebase that will be responsible for interacting with your application's <code>UIWindow</code>, handle abrupt login status change (redirect to login screen), update Keychain, etc.</p>
<p>This is where Cely comes in, it solves both problems by combining these two entirely different bits of functionality into one seamless all-in-one solution.</p>
<table>
<thead>
<tr>
<th></th>
<th>Cely</th>
</tr>
</thead>
<tbody>
<tr>
<td>🚤</td>
<td>Add login functionality in a fraction of the time</td>
</tr>
<tr>
<td>🔏</td>
<td>Store user information securely with Keychain</td>
</tr>
<tr>
<td>📖</td>
<td>100% open source under the MIT license</td>
</tr>
<tr>
<td>☄️</td>
<td>Battle tested architecture</td>
</tr>
<tr>
<td>👶</td>
<td>Simple and intutive API design</td>
</tr>
<tr>
<td>⚖️</td>
<td>Easily Add/Remove from existing codebase 🤗</td>
</tr>
</tbody>
</table>
<h2 id="questions-and-support">Questions and support<a class="headerlink" href="#questions-and-support" title="Permanent link">#</a></h2>
<p>Before submitting a new GitHub issue, please make sure to search for <a href="https://github.com/cely-tools/cely/issues">existing issues</a>.</p>
<p>If that doesn't help, please <a href="https://github.com/cely-tools/cely/issues">submit an issue</a> on GitHub and provide information about your application setup.</p>
<h2 id="license">License<a class="headerlink" href="#license" title="Permanent link">#</a></h2>
<p>This project is licensed under the terms of the MIT license. See the <a href="https://github.com/cely-tools/cely/blob/master/LICENSE">LICENSE</a> file.</p>
              
            </div>
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <!-- Copyright etc -->
    
      <p>Copyright &copy; 2020 <a href="http://celylog.in">Cely</a></p>
    
  </div>

  Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
      
        </div>
      </div>

    </section>

  </div>

  <div class="rst-versions" role="note" aria-label="versions">
    <span class="rst-current-version" data-toggle="rst-current-version">
      
          <a href="https://github.com/cely-tools/docs/" class="fa fa-github" style="float: left"> GitHub</a>
      
      
      
        <span style="margin-left: 15px"><a href="includes/installing-cely/" style">Next &raquo;</a></span>
      
    </span>
</div>
    <script>var base_url = '.';</script>
    <script src="js/theme.js" defer></script>
      <script src="search/main.js" defer></script>
    <script defer>
        window.onload = function () {
            SphinxRtdTheme.Navigation.enable(false);
        };
    </script>

  <link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
  <!-- at the end of the BODY -->
  <script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
  <script type="text/javascript">
    $(document).ready(() => $('table').addClass('docutils'));
    // PASTE doc search here
    /*
    docsearch({
      apiKey: '<KEY-GOES-HERE>',
      indexName: 'cely',
      inputSelector: '.wy-side-nav-search input[type="text"]',
      debug: false
    });
    */
  </script>

</body>
</html>

<!--
MkDocs version : 1.0.4
Build Date UTC : 2020-02-23 07:04:31
-->