Skip to content

Commit 527b598

Browse files
authored
Update README.md
1 parent cf71e10 commit 527b598

File tree

1 file changed

+10
-21
lines changed

1 file changed

+10
-21
lines changed

README.md

Lines changed: 10 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,26 @@
11
# Code0::Identities [![Build Status](https://img.shields.io/github/actions/workflow/status/code0-tech/code0-identities/main.yml?branch=main)](https://github.com/PaperMC/Paper/actions) ![GitHub Release](https://img.shields.io/github/v/release/code0-tech/code0-identities) ![Discord](https://img.shields.io/discord/1173625923724124200?label=Discord&color=blue)
22

3+
This gem can load and validate external identities
34

5+
## Supported platforms
46

5-
TODO: Delete this and the text below, and describe your gem
6-
7-
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/code0/identities`. To experiment with that code, run `bin/console` for an interactive prompt.
7+
OAuth:
8+
- Google
9+
- Discord
10+
- Microsoft
11+
- Github
12+
- Gitlab
813

914
## Installation
1015

11-
TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
12-
1316
Install the gem and add to the application's Gemfile by executing:
1417

15-
$ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
18+
$ bundle add code0-identities
1619

1720
If bundler is not being used to manage dependencies, install the gem by executing:
1821

19-
$ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
22+
$ gem install code0-identities
2023

2124
## Usage
2225

23-
TODO: Write usage instructions here
24-
25-
## Development
26-
27-
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
28-
29-
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
30-
31-
## Contributing
32-
33-
Bug reports and pull requests are welcome on GitHub at https://github.com/code0-tech/code0-identities.
34-
35-
## License
3626

37-
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)