Skip to content

Commit

Permalink
Create the project.
Browse files Browse the repository at this point in the history
  • Loading branch information
artob committed Jan 11, 2025
0 parents commit a9d47fc
Show file tree
Hide file tree
Showing 13 changed files with 151 additions and 0 deletions.
Empty file added .gitattributes
Empty file.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @artob
15 changes: 15 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# macOS
.DS_Store

# Visual Studio Code
.vscode/

# Editor backup files
*~

# Ruby artifacts
.bundle
.irb_history
.yardoc
Gemfile.lock
*.gem
1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* Arto Bendiken <[email protected]>
8 changes: 8 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## 0.0.0 - 2025-01-11
3 changes: 3 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
source "https://rubygems.org"

gemspec
52 changes: 52 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# NEAR.rb: NEAR for Ruby

[![License](https://img.shields.io/badge/license-Public%20Domain-blue.svg)](https://unlicense.org)
[![Compatibility](https://img.shields.io/badge/ruby-3.0%2B-blue)](https://rubygems.org/gems/near)
[![Package](https://img.shields.io/gem/v/near)](https://rubygems.org/gems/near)
[![Documentation](https://img.shields.io/badge/rubydoc-latest-blue)](https://rubydoc.info/gems/near)

**NEAR.rb** is a [Ruby] client library for the [NEAR Protocol].

## ✨ Features

- 100% free and unencumbered public domain software.

## 🛠️ Prerequisites

- [Ruby] 3.0+

## ⬇️ Installation

### Installation via RubyGems

```bash
gem install near
```

## 👉 Examples

### Importing the library

```ruby
require 'near'
```

## 📚 Reference

https://rubydoc.info/gems/near

## 👨‍💻 Development

```bash
git clone https://github.com/dryruby/near.rb.git
```

- - -

[![Share on Twitter](https://img.shields.io/badge/share%20on-twitter-03A9F4?logo=twitter)](https://x.com/share?url=https://github.com/dryruby/near.rb&text=NEAR.rb)
[![Share on Reddit](https://img.shields.io/badge/share%20on-reddit-red?logo=reddit)](https://reddit.com/submit?url=https://github.com/dryruby/near.rb&title=NEAR.rb)
[![Share on Hacker News](https://img.shields.io/badge/share%20on-hacker%20news-orange?logo=ycombinator)](https://news.ycombinator.com/submitlink?u=https://github.com/dryruby/near.rb&t=NEAR.rb)
[![Share on Facebook](https://img.shields.io/badge/share%20on-facebook-1976D2?logo=facebook)](https://www.facebook.com/sharer/sharer.php?u=https://github.com/dryruby/near.rb)

[NEAR Protocol]: https://near.org
[Ruby]: https://ruby-lang.org
24 changes: 24 additions & 0 deletions UNLICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <https://unlicense.org/>
1 change: 1 addition & 0 deletions VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
0.0.0
5 changes: 5 additions & 0 deletions lib/near.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# This is free and unencumbered software released into the public domain.

module NEAR; end

require_relative 'near/version'
1 change: 1 addition & 0 deletions lib/near/version.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# This is free and unencumbered software released into the public domain.
29 changes: 29 additions & 0 deletions near.gemspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Gem::Specification.new do |gem|
gem.version = File.read('VERSION').chomp
gem.date = File.mtime('VERSION').strftime('%Y-%m-%d')

gem.name = "near"
gem.homepage = "https://github.com/dryruby/near.rb"
gem.license = "Unlicense"
gem.summary = "NEAR.rb: NEAR for Ruby"
gem.description = "A Ruby client library for the NEAR Protocol."
gem.metadata = {
'bug_tracker_uri' => "https://github.com/dryruby/near.rb/issues",
'changelog_uri' => "https://github.com/dryruby/near.rb/blob/master/CHANGES.md",
'documentation_uri' => "https://rubydoc.info/gems/near",
'homepage_uri' => gem.homepage,
'source_code_uri' => "https://github.com/dryruby/near.rb",
}

gem.author = "Arto Bendiken"
gem.email = "[email protected]"

gem.platform = Gem::Platform::RUBY
gem.files = %w(AUTHORS CHANGES.md README.md UNLICENSE VERSION) + Dir.glob('lib/**/*.rb')
gem.bindir = %q(bin)
gem.executables = %w()

gem.required_ruby_version = '>= 3.0'
gem.add_development_dependency 'rspec', '~> 3.12'
gem.add_development_dependency 'yard' , '~> 0.9'
end
11 changes: 11 additions & 0 deletions spec/readme_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# This is free and unencumbered software released into the public domain.

require 'near'

RSpec.describe NEAR do
describe 'README examples' do
it 'roundtrip correctly' do
# TODO
end
end
end

0 comments on commit a9d47fc

Please sign in to comment.