Skip to content

Commit 548c28d

Browse files
committed
update gemspec + readme
1 parent bb6c320 commit 548c28d

File tree

2 files changed

+19
-18
lines changed

2 files changed

+19
-18
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
# SqliteFts
2-
Short description and motivation.
32

4-
## Usage
5-
How to use my plugin.
3+
Provides all the missing pieces to support the SQLite FTS.
4+
5+
## TODOs
6+
7+
- [ ] Support Virtual Tables and Shadow tables in schema.rb/structure.sql
8+
- [ ] Support creating a virtual table in a migration
9+
- [ ] Support `Record.search('abc')`
10+
- [ ] Upstream all ActiveRecord related code
611

712
## Installation
13+
814
Add this line to your application's Gemfile:
915

1016
```ruby
@@ -16,13 +22,10 @@ And then execute:
1622
$ bundle
1723
```
1824

19-
Or install it yourself as:
20-
```bash
21-
$ gem install sqlite_fts
22-
```
23-
2425
## Contributing
26+
2527
Contribution directions go here.
2628

2729
## License
30+
2831
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

sqlite_fts.gemspec

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,18 @@ require_relative "lib/sqlite_fts/version"
33
Gem::Specification.new do |spec|
44
spec.name = "sqlite_fts"
55
spec.version = SqliteFts::VERSION
6-
spec.authors = ["Niklas Haeusele"]
6+
spec.authors = ["Niklas Häusele"]
77
spec.email = ["niklas.haeusele@hey.com"]
8-
spec.homepage = "TODO"
9-
spec.summary = "TODO: Summary of SqliteFts."
10-
spec.description = "TODO: Description of SqliteFts."
8+
spec.homepage = "https://www.github.com/codergeek121/sqlite_fts"
9+
spec.summary = "Rails plugin to support SQLite FTS"
10+
spec.description = "All the missing glue to use the SQLite FTS"
1111
spec.license = "MIT"
1212

13-
# Prevent pushing this gem to RubyGems.org. To allow pushes either set the "allowed_push_host"
14-
# to allow pushing to a single host or delete this section to allow pushing to any host.
15-
spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
16-
1713
spec.metadata["homepage_uri"] = spec.homepage
18-
spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
19-
spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
14+
spec.metadata["source_code_uri"] = spec.homepage
15+
16+
# TODO
17+
# spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
2018

2119
spec.files = Dir.chdir(File.expand_path(__dir__)) do
2220
Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.md"]

0 commit comments

Comments
 (0)