From 62198b812fb284549a6f7a70d2cdec88b7e27dbe Mon Sep 17 00:00:00 2001 From: Omar Bahareth Date: Fri, 12 Jul 2024 16:59:40 +0300 Subject: [PATCH] Rename SDK to Avoid Conflicts MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Since we’re moving maintenance to here, we’ll simply rename the gem to zatca-sdk --- .gitignore | 3 ++- README.md | 19 ++++++++++++------- zatca.gemspec => zatca_sdk.gemspec | 10 +++++----- 3 files changed, 19 insertions(+), 13 deletions(-) rename zatca.gemspec => zatca_sdk.gemspec (87%) diff --git a/.gitignore b/.gitignore index 7159d52..d91e70f 100644 --- a/.gitignore +++ b/.gitignore @@ -8,4 +8,5 @@ /tmp/ /*.pem .byebug_history -Gemfile.lock \ No newline at end of file +Gemfile.lock +/*.gem diff --git a/README.md b/README.md index 9096a5a..0d9d139 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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. - - diff --git a/zatca.gemspec b/zatca_sdk.gemspec similarity index 87% rename from zatca.gemspec rename to zatca_sdk.gemspec index 5fc329f..eb5473e 100644 --- a/zatca.gemspec +++ b/zatca_sdk.gemspec @@ -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 = ["obahareth@mrsool.co"] + spec.email = ["omar@omar.engineer"] 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.