Skip to content

Commit

Permalink
chore: prep for 2.0.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
kevboh committed Oct 29, 2022
1 parent ed58703 commit aec9ecd
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 10 deletions.
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
**WARNING**: This branch of Longform is in beta. It may not be stable. The docs and this README have been updated to reflect how the beta works, and may not apply to the current published version.

## Longform

Longform is a plugin for [Obsidian](https://obsidian.md) that helps you write and edit novels, screenplays, and other long projects. It lets you organize a series of notes, or _scenes_, into an ordered manuscript. It also supports single-note projects for shorter works. Major features include:
Expand All @@ -9,6 +7,7 @@ Longform is a plugin for [Obsidian](https://obsidian.md) that helps you write an
- Scene/draft/project [word counts](./docs/WORD_COUNTS.md#word-counts-for-projects-drafts-and-scenes);
- Daily [writing session goals](./docs/WORD_COUNTS.md#writing-sessions-and-word-count-goals) with lots of options to help fit your writing style;
- A [workflow-based compilation tool](./docs/COMPILE.md) that can create manuscripts from your projects;
- Support for [single-scene projects](/docs/SINGLE_SCENE_PROJECTS.md) so that your shorter works can use the same workflows and tooling as your longer ones;
- Plus lots of commands, modals, and menu items to help you manage your work.

A Getting Started guide follows; there is also reasonably-complete [documentation](./docs/).
Expand All @@ -21,10 +20,6 @@ Longform is in the Community Plugins section of Obsidian’s settings. You may a

Longform works by searching your vault for any note that contains a frontmatter entry named `longform` (don’t worry if you don’t know what that means; Longform includes tools to help you generate these files). You can think of these notes as the “spines” or tables of contents of your projects. Let‘s walk through creating two different Longform projects: a novel and a short story.

> **Note**
>
> A [video version of this walkthrough](#) is also available.
### Creating a Novel

1. To begin, find or create a folder somewhere in your vault in which you’d like to create your novel. Right-click it and select `Create Longform Project`.
Expand All @@ -41,7 +36,7 @@ Longform works by searching your vault for any note that contains a frontmatter
>
> You don’t have to use this menu item and modal to create Longform projects. As you will see shortly, Longform projects are one or more notes organized around some YAML frontmatter. You can always create a note yourself somewhere in your vault and use the `Insert Multi-Scene Frontmatter` and `Insert Single-Scene Frontmatter` commands to populate the note—Longform will recognize it automatically. Although not recommended, you can also author the YAML frontmatter manually, too.
4. Click `Create`. Longform has created the promised file. If we switch to the [Longform pane](./docs/THE_LONGFORM_PANE.md) in the sidebar, the project is already selected. You should see three tabs: Scenes, Project, and Compile, and Scenes should be selected.
4. Click `Create`. Longform has created the promised file. If we switch to the [Longform pane](./docs/THE_LONGFORM_PANE.md) in the sidebar the project is already selected. You should see three tabs: Scenes, Project, and Compile, and Scenes should be selected.

![The newly-created project in the Longform pane](./docs/res/walkthrough-multi-fresh-pane.png)

Expand Down
4 changes: 4 additions & 0 deletions docs/WORD_COUNTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,7 @@ The status bar count will show scene (if a multi-scene project) and draft word c
## Writing Sessions and Word Count Goals

Longform also includes support for writing sessions. Sessions are some length of time in which you are writing against a word count goal. Longform will notify you when you’ve hit your goal. This behavior is customizable via a number of settings.

## Session Storage

By default, the data comprising your sessions is stored in the same file as other plugin settings. This can be changed via settings to store data in a dedicated `.json` file in the settings folder _or_ in a `.json` file somewhere in your vault; you might want to do this if you’d like to keep your session data per-device via `.gitignore`, for example.
6 changes: 3 additions & 3 deletions manifest.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"id": "longform",
"name": "Longform",
"version": "1.1.0",
"minAppVersion": "0.12.11",
"version": "2.0.0",
"minAppVersion": "1.0",
"description": "Write novels, screenplays, and other long projects in Obsidian.",
"author": "Kevin Barrett",
"authorUrl": "https://kevinbarrett.org",
"isDesktopOnly": false
}
}

0 comments on commit aec9ecd

Please sign in to comment.