README.md in scrapbook-0.2.0 vs README.md in scrapbook-0.2.1
- old
+ new
@@ -24,11 +24,11 @@
end
```
And then execute:
-```bash
+```
$> bundle install
$> bundle exec rails generate scrapbook:install
```
This will install the gem and setup the default Scrapbook route and create the default
@@ -68,36 +68,36 @@
path you want: `mount Scrapbook::Engine => "/scrappy"`.
You can configure one or more folders to be separate root scrapbooks via the
`config.scrapbook.paths` option. This option defaults to an empty array which allows for
using the shovel operator to add your paths:
- ```ruby
- Rails.application.configure do
- config.scrapbook.paths << Rails.root.join("scrapbooks/main")
- config.scrapbook.paths << Rails.root.join("scrapbooks/scratch")
- end
- ```
+```ruby
+Rails.application.configure do
+ config.scrapbook.paths << Rails.root.join("scrapbooks/main")
+ config.scrapbook.paths << Rails.root.join("scrapbooks/scratch")
+end
+```
If no paths have been added, Scrapbook will use `Rails.root.join('scrapbook')` as the
location it expects the scrapbook to be at. The first folder path in the array is considered
the default scrapbook and will be available at the root mount point configured in the routes
file.
We recommend only running Scrapbook in development / non-production Rails environments.
However, if you find yourself needing to be able to run it in an environment precompiles its
assets, you will need to configure Scrapbook to be part of the precompilation. You can do
this by setting `config.scrapbook.precompile_assets` to "true":
- ```ruby
- Rails.application.configure do
- config.scrapbook.precompile_assets = true
- end
- ```
+```ruby
+Rails.application.configure do
+ config.scrapbook.precompile_assets = true
+end
+```
## Contributing
-If you have a question about Scrapbook, feel free to ask in [the repository's Discussions]
-[Discussions]. Before starting any work or creating any issues, please read [the
+If you have a question about Scrapbook, feel free to ask in [the repository's
+Discussions][Discussions]. Before starting any work or creating any issues, please read [the
contribution guidelines](CONTRIBUTING.md).
## Development Setup
### Install TailwindCSS CLI
@@ -114,11 +114,11 @@
Once Tailwind's CLI has been installed, you can run it using the command below to update
Scrapbook's CSS:
```
-$> npx tailwindcss -i app/assets/stylesheets/scrapbook/application.tailwind.css -o app/assets/builds/scrapbook/tailwind.css --minify --watch
+$> npx tailwindcss -i app/assets/stylesheets/scrapbook/application.tailwind.css -o app/assets/builds/scrapbook/application.css --minify --watch
```
(Note, the "tailwindcss-rails" gem currently doesn't support Rails engines, so we have to
install and run Tailwind manually.)
@@ -128,15 +128,15 @@
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
- http://www.apache.org/licenses/LICENSE-2.0
+[http://www.apache.org/licenses/LICENSE-2.0]()
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
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.
-[Discussion]: https://github.com/bfad/scrapbook/discussions
+[Discussions]: https://github.com/bfad/scrapbook/discussions