Skip to content

Commit

Permalink
Rename SDK to Avoid Conflicts
Browse files Browse the repository at this point in the history
Since we’re moving maintenance to here, we’ll simply rename the gem to zatca-sdk
  • Loading branch information
obahareth committed Jul 12, 2024
1 parent 2cddf57 commit 62198b8
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 13 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@
/tmp/
/*.pem
.byebug_history
Gemfile.lock
Gemfile.lock
/*.gem
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,29 @@
# zatca
![](https://img.shields.io/gem/v/zatca) ![](https://img.shields.io/github/actions/workflow/status/mrsool/zatca/test.yml?branch=main)
![](https://img.shields.io/gem/v/zatca) ![](https://img.shields.io/github/actions/workflow/status/obahareth/zatca/test.yml?branch=main)

A Ruby library for generating QR Codes and e-invoices according to the standard created by ZATCA in Saudi Arabia.

This library supports both Phase 1 and Phase 2. Phase 2 support is still new so there may be bugs. Please [report any issues](https://github.com/mrsool/zatca/issues/new) you find.
This library supports both Phase 1 and Phase 2. Phase 2 support is still new so there may be bugs. Please [report any issues](https://github.com/obahareth/zatca/issues/new) you find.

# Installation

## Rubygems
```sh
gem install zatca
gem install zatca-zdk
```

## Bundler
```sh
bundle add zatca
bundle add zatca-sdk
```

## Migrating from Original Version
If you were using the original version of this library, you can migrate to the new version by changing the gem name in your Gemfile from `zatca` to `zatca-sdk`.

As of this moment there are no new changes to the API, so you should be able to use the new version without any changes to your code.

This fork was made because my access to the original repository was removed and I wanted to continue maintaining the library.

# Usage

## Phase 1
Expand Down Expand Up @@ -54,9 +61,7 @@ generator.render(size: 512)
```

## Phase 2
Documentation lives in the [wiki](https://github.com/mrsool/zatca/wiki)
Documentation lives in the [wiki](https://github.com/obahareth/zatca/wiki)

# Notice of Non-Affiliation and Disclaimer
This library is not affiliated, associated, authorized, endorsed by, or in any way officially connected with ZATCA (Zakat, Tax and Customs Authority), or any of its subsidiaries or its affiliates. The official ZATCA website can be found at https://zatca.gov.sa.


10 changes: 5 additions & 5 deletions zatca.gemspec → zatca_sdk.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,21 @@
require_relative "lib/zatca/version"

Gem::Specification.new do |spec|
spec.name = "zatca"
spec.name = "zatca-sdk"
spec.version = ZATCA::VERSION
spec.authors = ["Omar Bahareth"]
spec.email = ["[email protected]"]
spec.email = ["[email protected]"]

spec.summary = "A library for generating QR Codes for the e-invoice standard by ZATCA in Saudi Arabia."
spec.description = "A library for generating QR Codes for the e-invoice standard by ZATCA in Saudi Arabia."
spec.homepage = "https://github.com/mrsool/zatca"
spec.homepage = "https://github.com/obahareth/zatca"
spec.required_ruby_version = ">= 2.5.0"

spec.metadata["allowed_push_host"] = "https://rubygems.org"

spec.metadata["homepage_uri"] = spec.homepage
spec.metadata["source_code_uri"] = "https://github.com/mrsool/zatca"
spec.metadata["changelog_uri"] = "https://github.com/mrsool/zatca/releases"
spec.metadata["source_code_uri"] = "https://github.com/obahareth/zatca"
spec.metadata["changelog_uri"] = "https://github.com/obahareth/zatca/releases"

# Specify which files should be added to the gem when it is released.
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
Expand Down

0 comments on commit 62198b8

Please sign in to comment.