filepress 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e03605fd0950c7f477b42f3c7e0a1945fb36beb2e36712d07b3f3afea0589174
-  data.tar.gz: bb918105f4fcfd3e0c69c0c989a6be41894e364f86243f42ec609f251548cf66
+  metadata.gz: 7d19a795578233e2969fa1438a21c7614afab2650666a2a229338c2f322cccc0
+  data.tar.gz: cfcfbff322ea8909a384f580b6de6082f4a015808acb6d5e3f03a5bc02d17d54
 SHA512:
-  metadata.gz: 340b5ac2730761c80eb9c7168ba034df36c99035cb9fce1dc6ced9fab58535c81983c49386141e03c824765f0962810249e75abb485df445aedf288aad8038fd
-  data.tar.gz: 80ed126ff2e59a217d061f88f183d7ea2fde0d5f352547061f0b30dbf5c325862534ef8b0e995367fd19ee2694c83c2ad4b7df75dac53aa6111a2b767c53ce5c
+  metadata.gz: a69c6dbb2a9491da1698d9d97ba37ebb4e3e6caceffa1b0d4e7c21d782c0d5d4111869c075fcddb339dd0df471db291a9f43f197cd11dbb9871042b013b5f14c
+  data.tar.gz: 9590840f2f26567dca12b04fc929c2273a5f21074b179abdf7fb0f96dc22de5720a9d2bb37c8eede06c516ebb7bfcf7b1c8e0ae7eacc6192b782a5a3c9406a4e

data/README.md

@@ -1,17 +1,122 @@
 # Filepress
 
-**Write content as flat files. Use it anywhere in your Rails app.**
+Filepress is a minimal Rails plugin that offers the best of both worlds for content management:
+- Write and version control your content in Markdown (or a similar format)
+- Sync it seamlessly to ActiveRecord models so you can harness the full power of a Rails backend.
 
-Filepress lets you manage content in plain text files with frontmatter — like Markdown, HTML, or anything else — and sync them directly into your ActiveRecord models. It's the simplicity of static files, with the full power of a Rails backend.
+Ideal for blogs, documentation, or any content-driven Rails app where you want the flexibility of flat files and the structure of a database.
 
----
+## Getting Started
+
+1. Install the gem
+
+Add it to your Gemfile:
+
+```ruby
+gem "filepress"
+```
+Then run:
+
+```bash
+bundle install
+```
+
+2. Create a model to represent your content
+
+Be sure to include a field that can serve as a unique identifier (e.g. `slug`):
+
+```bash
+rails g model Post title:string slug:string body:text
+```
+
+3. Enable Filepress for your model
 
-## ✨ Why use Filepress?
+Use the `filepress` method in your model class:
 
-- 📝 Write content in any editor — no CMS required
-- 🔁 Keep content version-controlled with Git
-- ⚡ Instantly available in your Rails app via ActiveRecord
-- 🧠 Works with any file type (Markdown, HTML, plain text, etc.)
-- 🧹 Automatically adds, updates, and deletes records
+```ruby
+class Post < ApplicationRecord
+    filepress
+end
+```
 
+4. Add some content
+
+Create Markdown files in `app/content/posts`. Each file should include frontmatter:
+
+```markdown
+---
+title: My First Post
+slug: first
 ---
+
+# Hello, this is my first post
+```
+
+5. Sync your content
+
+Run the sync task to import your files into the database:
+
+```bash
+bin/rails filepress:sync
+```
+
+That’s it! You’re now free to query your content via ActiveRecord like any other model. Filepress doesn't dictate how you render the body—use a Markdown parser like Kramdown, Redcarpet, or similar.
+
+## How it works
+
+Filepress reads your content files, extracts YAML frontmatter, and uses the values to populate or update model attributes. The rest of the file becomes the value of the body attribute (or another field, if configured).
+
+## Configuration
+
+You can customize how Filepress behaves by passing options to `filepress`:
+
+### `from:` - Set a custom content directory
+
+```ruby
+class Post
+    filepress from: "app/my_custom_content_folder"
+end
+```
+
+### `glob:` - Use filetypes besides Markdown
+
+```ruby
+class Post
+    filepress glob: "*.html"
+end
+```
+
+### `key:` - Use a unique identifier other than `slug`
+
+```ruby
+class Post
+    filepress key: :name
+end
+```
+
+### `body:` - Set which attribute stores the main content
+
+```ruby
+class Post
+    filepress body: :content
+end
+```
+
+### `destroy_stale:` - Prevent deletion of records when files are removed
+
+By default, Filepress deletes records when the corresponding file is removed. Disable this behavior with:
+
+```ruby
+class Post
+    filepress destroy_stale: false
+end
+```
+
+## Why Filepress?
+
+Filepress is for you if:
+
+- You prefer writing content in files
+- You want the convenience of version control for content
+- And you still want powerful querying, associations, validations and all the other Rails goodness
+

data/lib/filepress/version.rb

@@ -1,3 +1,3 @@
 module Filepress
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: filepress
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Carl Dawson
@@ -45,7 +45,7 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/carldaws/filepress
-  source_code_uri: https://github.com/carldawson/filepress
+  source_code_uri: https://github.com/carldaws/filepress
 rdoc_options: []
 require_paths:
 - lib