Skip to content

Commit 0c15eda

Browse files
committed
readme updates
1 parent 8b0021f commit 0c15eda

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# sqlite_extensions-uuid
22

3-
Sqlite's [uuid v4 extension](https://sqlite.org/src/file/ext/misc/uuid.c?t=version-3.46.1), packaged as a gem.
3+
SQLite's [uuid v4 extension](https://sqlite.org/src/file/ext/misc/uuid.c?t=version-3.46.1), packaged as a gem.
44

55
Useful for using UUIDs as primary keys in a Rails app.
66

@@ -18,7 +18,7 @@ If you're _not_ using Rails, you can omit the `require` above.
1818

1919
## Usage
2020

21-
Sqlite's uuid extension provides the following:
21+
SQLite's uuid extension provides the following:
2222

2323
- `uuid()` - generate a version 4 UUID as a string
2424
- `uuid_str(X)` - convert a UUID X into a well-formed UUID string
@@ -35,17 +35,17 @@ For more information, see the extension's [source code](https://sqlite.org/src/f
3535

3636
## Design
3737

38-
This gem compiles Sqlite's uuid extension into a shared library using Ruby's native-gem functionality.
38+
This gem compiles SQLite's uuid extension into a shared library using Ruby's native-gem functionality.
3939

40-
It doesn't actually compile a Ruby native extension, it just uses the ruby extension process to compile the Sqlite library.
40+
It doesn't actually compile a Ruby native extension, it just uses the ruby extension process to compile the SQLite library.
4141

4242
It then exposes a method (`SqliteExtensions::UUID.extension_path`) which returns the location of that shared library, which can be passed to [sqlite3](https://github.com/sparklemotion/sqlite3-ruby)'s `load_extension` method.
4343

44-
Additionally, it exposes a railtie (via `require: "sqlite_extensions/uuid/rails"`) that patches Rails' [configure_connection](https://github.com/rails/rails/blob/v8.0.0.rc1/activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb#L815) method for the sqlite adapter, so that all sqlite database connections load the extension.
44+
Additionally, it exposes a railtie (via `require: "sqlite_extensions/uuid/rails"`) that patches Rails' [configure_connection](https://github.com/rails/rails/blob/v8.0.0.rc1/activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb#L815) method for the SQLite adapter, so that all SQLite database connections load the extension.
4545

4646
## Development
4747

48-
```
48+
```shell
4949
# one-time setup
5050
bundle
5151

@@ -64,7 +64,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/jethro
6464

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

67-
The following files are copied verbatim from Sqlite, and are used under their own license, which is visible at the beginning of each file:
67+
The following files are copied verbatim from SQLite, and are used under their own license, which is visible at the beginning of each file:
6868

6969
- `ext/sqlite_extensions/uuid/sqlite3ext.h`
7070
- `ext/sqlite_extensions/uuid/sqlite3.h`

0 commit comments

Comments
 (0)