Skip to content

Commit

Permalink
FAQ addition.
Browse files Browse the repository at this point in the history
  • Loading branch information
jlevy committed Oct 25, 2024
1 parent f2c3b53 commit 7999a58
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,9 +281,14 @@ print(raw_metadata) # 'title: Test Title\nauthor: Test Author\n'

## FAQ

- **Hasn't this been done before?** Possibly, but as far as I can tell, not in a systematic
way for multiple file formats.
I needed this myself, and think we'd all be better off if more tools used YAML metadata
consistently, so I've released the format and implementation here.

- **Is this mature?** This is the first draft of this format.
But I've been using this on my own projects for a couple months.
The flexibity of just having metadata on all your text files is great for workflows,
The flexibity of just having metadata on all your text files has been great for workflows,
pipelines, etc.

- **When should we use it?** All the time if you can!
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name = "frontmatter-format"
# Keep this a dev version, as the dynamic versioning plugin is used for actual release versions:
version = "0.0.0.dev"
description = "A format for YAML frontmatter on any file."
description = "A micro-format for YAML metadata on any file."
authors = ["Joshua Levy <[email protected]>"]
readme = "README.md"
license = "MIT"
Expand Down

0 comments on commit 7999a58

Please sign in to comment.