Skip to content

Commit

Permalink
Remove unnecessary files and update .gitignore to exclude Gemfile.lock
Browse files Browse the repository at this point in the history
  • Loading branch information
ydah committed Jan 24, 2025
1 parent a5e3ad2 commit 953815a
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 190 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@
/pkg/
/spec/reports/
/tmp/
Gemfile.lock
5 changes: 0 additions & 5 deletions CHANGELOG.md

This file was deleted.

132 changes: 0 additions & 132 deletions CODE_OF_CONDUCT.md

This file was deleted.

26 changes: 0 additions & 26 deletions Gemfile.lock

This file was deleted.

File renamed without changes.
33 changes: 10 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,24 @@
# Parsel

TODO: Delete this and the text below, and describe your gem

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/parsel`. To experiment with that code, run `bin/console` for an interactive prompt.
Parsel is a module providing a simple way to parse and extract data from a css selector.

## Installation

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.

Install the gem and add to the application's Gemfile by executing:
Add this line to your application's Gemfile:
```ruby
gem 'parsel'
```

And then execute:
```bash
bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
bundle install
```

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

Or install it yourself as:
```bash
gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
gem install parsel
```

## Usage

TODO: Write usage instructions here

## Development

After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
Expand All @@ -32,12 +27,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/parsel. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/parsel/blob/main/CODE_OF_CONDUCT.md).

## 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 Parsel project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/parsel/blob/main/CODE_OF_CONDUCT.md).
Bug reports and pull requests are welcome on GitHub at https://github.com/ydah/parsel.
4 changes: 0 additions & 4 deletions sig/parsel.rbs

This file was deleted.

0 comments on commit 953815a

Please sign in to comment.