docs: Add Markdown developer documentation

.github/workflows/deploy.yml

@@ -0,0 +1,59 @@
+name: Deploy
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1', '3.2']
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Install dependencies
+      run: bundle install
+    - name: Run RSpec
+      run: bundle exec rspec
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.2'
+        bundler-cache: true
+    - name: Install dependencies
+      run: bundle install
+    - name: Run RuboCop
+      run: bundle exec rubocop
+
+  deploy:
+    needs: [test, lint]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.2'
+        bundler-cache: true
+    - name: Install dependencies
+      run: bundle install
+    - name: Build gem
+      run: gem build *.gemspec
+    - name: Push to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        echo ":rubygems_api_key: ${{ secrets.RUBY_GEMS_TOKEN }}" > $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        gem push *.gem

.gitignore

@@ -3,3 +3,5 @@ Gemfile.lock
 .DS_Store
 pkg
 vendor/bundle
+.yardoc
+doc

CODE_OF_CONDUCT.md

@@ -0,0 +1,66 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+*   Demonstrating empathy and kindness toward other people
+*   Being respectful of differing opinions, viewpoints, and experiences
+*   Giving and gracefully accepting constructive feedback
+*   Accepting responsibility and apologizing to those affected by our mistakes,
+    and learning from the experience
+*   Focusing on what is best not just for us as individuals, but for the
+    overall community
+
+Examples of unacceptable behavior include:
+
+*   The use of sexualized language or imagery, and sexual attention or
+    advances of any kind
+*   Trolling, insulting or derogatory comments, and personal or political attacks
+*   Public or private harassment
+*   Publishing others' private information, such as a physical or email
+    address, without their explicit permission
+*   Other conduct which could reasonably be considered inappropriate in a
+    professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html

README.md

@@ -2,7 +2,15 @@
 
 A modern, robust, and fully-featured Ruby client for the Zadarma API. This gem has been updated to support the latest Zadarma API, providing a clean and intuitive interface for all available endpoints.
 
-## Installation
+## Getting Started
+
+### Prerequisites
+
+- Ruby 2.7 or later
+- A Zadarma account
+- Your Zadarma API key and secret
+
+### Installation
 
 Add this line to your application's Gemfile:
 
@@ -18,7 +26,7 @@ Or install it yourself as:
 
     $ gem install zadarma
 
-## Usage
+## Configuration
 
 First, configure the client with your API key and secret. You can find these in your Zadarma personal account.
 
@@ -28,6 +36,8 @@ require 'zadarma'
 client = Zadarma::Client.new(api_key: 'YOUR_API_KEY', api_secret: 'YOUR_API_SECRET')
 ```
 
+## Usage
+
 Now you can call any of the available API methods:
 
 ### Get Your Balance
@@ -92,7 +102,7 @@ This client is organized into resources, mirroring the Zadarma API structure.
     *   `statistics(start:, end_date:, sip: nil, cost_only: nil, type: nil, skip: nil, limit: nil)`: Get overall call statistics.
     *   `pbx_statistics(start:, end_date:, version: nil, skip: nil, limit: nil, call_type: nil)`: Get PBX call statistics.
 
-## Development & Testing
+## Development
 
 To work on this gem locally, clone the repository and then run `bundle install` to install the dependencies.
 
@@ -109,3 +119,15 @@ The test suite is configured to use `webmock` to stub out all API requests, so y
 3.  Commit your changes (`git commit -am 'Add some feature'`)
 4.  Push to the branch (`git push origin my-new-feature`)
 5.  Create a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https'://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Zadarma project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+
+## Version History
+
+*   **2.0.0** - The current version.