Skip to content

Commit 9ee4127

Browse files
author
Konstantin Gredeskoul
committed
Updating README
1 parent 95d966e commit 9ee4127

File tree

1 file changed

+39
-18
lines changed

1 file changed

+39
-18
lines changed

README.md

Lines changed: 39 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,31 @@
1-
# Rules ruby
2-
[![Build Status](https://travis-ci.org/yugui/rules_ruby.svg?branch=master)](https://travis-ci.org/yugui/rules_ruby)
1+
<!-- TOC depthFrom:2 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->
2+
3+
- [Status](#status)
4+
- [How to use](#how-to-use)
5+
- [Rules](#rules)
6+
- [`ruby_library`](#rubylibrary)
7+
- [`ruby_binary`](#rubybinary)
8+
- [ruby_test](#rubytest)
9+
- [`bundle_install`](#bundleinstall)
10+
- [What's coming next](#whats-coming-next)
11+
- [Copyright](#copyright)
12+
- [Warranty](#warranty)
13+
14+
<!-- /TOC -->
15+
16+
# Rules Ruby
17+
18+
[![Build Status](https://travis-ci.org/bazelruby/rules_ruby.svg?branch=master)](https://travis-ci.org/bazelruby/rules_ruby)
319

420
Ruby rules for [Bazel](https://bazel.build).
521

622
## Status
7-
Proof of Concept
23+
24+
Work in progress.
825

926
## How to use
1027

11-
Add `ruby_rules_dependencies` and `ruby_register_toolchains` into your
12-
`WORKSPACE` file.
28+
Add `ruby_rules_dependencies` and `ruby_register_toolchains` into your `WORKSPACE` file.
1329

1430
```python
1531
git_repository(
@@ -59,10 +75,13 @@ ruby_test(
5975
```
6076

6177
## Rules
62-
### ruby_library
78+
79+
### `ruby_library`
80+
6381
<pre>
6482
ruby_library(name, deps, srcs, data, compatible_with, deprecation, distribs, features, licenses, restricted_to, tags, testonly, toolchains, visibility)
6583
</pre>
84+
6685
<table class="table table-condensed table-bordered table-params">
6786
<colgroup>
6887
<col class="col-param" />
@@ -132,10 +151,12 @@ ruby_library(name, deps, srcs, data, compatible_with, deprecation, distribs, fea
132151
</tbody>
133152
</table>
134153

135-
### ruby_binary
154+
### `ruby_binary`
155+
136156
<pre>
137157
ruby_binary(name, deps, srcs, data, main, compatible_with, deprecation, distribs, features, licenses, restricted_to, tags, testonly, toolchains, visibility, args, output_licenses)
138158
</pre>
159+
139160
<table class="table table-condensed table-bordered table-params">
140161
<colgroup>
141162
<col class="col-param" />
@@ -290,7 +311,8 @@ ruby_test(name, deps, srcs, data, main, compatible_with, deprecation, distribs,
290311
</tbody>
291312
</table>
292313

293-
### bundle_install
314+
### `bundle_install`
315+
294316
Installs gems with Bundler, and make them available as a `ruby_library`.
295317

296318
Example: `WORKSPACE`:
@@ -368,26 +390,25 @@ bundle_install(name, gemfile, gemfile_lock)
368390
<p>The <code>Gemfile.lock</code> which Bundler runs with.</p>
369391
<p>NOTE: This rule never updates the <code>Gemfile.lock</code>. It is your responsibility to generate/update <code>Gemfile.lock</code></p>
370392
</td>
371-
</tr>
393+
</tr>
372394
</tbody>
373395
</table>
374396

375397
## What's coming next
398+
376399
1. Building native extensions in gems with Bazel
377400
2. Using a specified version of Ruby.
378401
3. Building and releasing your gems with Bazel
379402

380403
## Copyright
381-
Copyright 2018 Yuki Yugui Sonoda
382404

383-
Licensed under the Apache License, Version 2.0 (the "License");
384-
you may not use this file except in compliance with the License.
385-
You may obtain a copy of the License at
405+
© 2018-2019 Yuki Yugui Sonoda & BazelRuby Authors
406+
407+
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
386408

387409
http://www.apache.org/licenses/LICENSE-2.0
388410

389-
Unless required by applicable law or agreed to in writing, software
390-
distributed under the License is distributed on an "AS IS" BASIS,
391-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
392-
See the License for the specific language governing permissions and
393-
limitations under the License.
411+
### Warranty
412+
413+
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS,
414+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

0 commit comments

Comments
 (0)