rubydex 0.0.1 → 0.1.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18a9330134cfad427b84b1478ff269332e4084040d10894499b72a1901e9c6a8
-  data.tar.gz: a60228127efc9619d3508e75af3eab1c5ee9c81c6db84fe5f23fab6bfebe062b
+  metadata.gz: 49d742ca9aba88c7ee0a7c67830f092f1dd73e7b867977b1301bf6b3d1a775b1
+  data.tar.gz: db24001d8625c08fdf3c1ddf252735a1d1bab9d6f5ce8da8af565dcf64c4d4c5
 SHA512:
-  metadata.gz: 81335413b8c1dafcce9b2bbaca68b6527bcc2306928e7b8c291e3db6dfd8909f68f42cc30d896a83b9f69675fb42c774e6edd524a1b68b8cf04eb87b7cb704bb
-  data.tar.gz: '0943df4ca315b2dd765cb9739712d7f34cffcc7164057f43ded882695ef61c17e39f38142cb1e62265279c3b8e91b6b59a3a2e0413d767c465634b9e988cee5b'
+  metadata.gz: 0be01d7da77e0934c2ead5ffcbfffd552b17dbdca3e038485c932af0420d52a33a32cc7acece7e939a3c2dbc51c25574c1850fd58487c837e0455db55c844a27
+  data.tar.gz: b0ed0cec3f8e97b139350e6ad339898906915ab739872e7ae7eb48acaa2924599ae82edc587228f090c83450dcb7fd44b66adebca83394b64ad3b7ec39823777

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2025 Ufuk Kayserilioglu
+Copyright (c) 2025-present, Shopify Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,3 +19,5 @@ AUTHORS OR COPYRIGHT HOLDERS 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.
+
+See the generated THIRD_PARTY_LICENSES.html file for third party licenses.

data/README.md

@@ -1,43 +1,25 @@
 # Rubydex
 
-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/rubydex`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-## 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:
-
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-```
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-```
+This project is a high performance static analysis toolkit for the Ruby language. The goal is to be a solid
+foundation to power a variety of tools, such as type checkers, linters, language servers and more.
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
+Both Ruby and Rust APIs are made available through a gem and a crate, respectively. Here's a simple example
+of using the Ruby API:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+# Create a new graph representing the current workspace
+graph = Rubydex::Graph.new
+# Index the entire workspace with all dependencies
+graph.index_workspace
+# Transform the initially collected information into its semantic understanding by running resolution
+graph.resolve
 
-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).
+# Access the information as needed
+graph["Foo"]
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/paracycle/rubydex. 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/paracycle/rubydex/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 Rubydex project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/paracycle/rubydex/blob/main/CODE_OF_CONDUCT.md).
+See [the contributing documentation](CONTRIBUTING.md).