From b73a3a46a41f8570d0a598a9e787b79782007368 Mon Sep 17 00:00:00 2001 From: Zach Hannum Date: Fri, 6 May 2022 15:51:27 -0400 Subject: [PATCH] Update README, bump version --- README.md | 48 ++++++++++++++++++++++++++++++++++++++-- release/app/package.json | 2 +- 2 files changed, 47 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6bc3e36..8654143 100644 --- a/README.md +++ b/README.md @@ -26,11 +26,55 @@ Calamus is a React Electron application for writing and publishing novels. ### :dart: Features -For a feature roadmap, please visit our Project Board. +Calamus is currently still in pre-alpha stages---not all features are available. For a feature roadmap, please visit our Project Board. + +#### 🖊️ Write Your Next Novel + +Calamus has what you need to organize and write your next novel. Organize your project into folders and use Markdown to make writing a breeze. + +#### 👐 Open Format + +Calamus stores all of your project data in a human readable json format. In addition, all book content is written using Markdown, making all of your work truly portable. You can export all of your book's content into markdown files at any time. + +##### .cala Format + +
+ +Calamus project files use the `.cala` file extension, but are really just `json` files (yes this means you can edit `.cala` files by hand, but it is not recommended!). See below for a table detailing the properties inside of a `.cala` file. + +| Property Name | Description | +|---------------|----------------------------------------------------------------------------------| +| bookTitle | The novel's title. | +| bookSubTitle | YThe novel's sub title. This is an optional property. | +| authorName | The novel's author name. | +| seriesName | The name of the series the novel is a part of. This is an optional property. | +| ISBN | The novel's ISBN number. | +| language | The language the novel is written in. | +| publisher | The name of the novel's publisher. | +| content | Array containing the novel's content. See a table detailing the `Section` below. | + +The content property contains a JSON array of the `Section` object type, detailed below. + +| Property Name | Description | +|-----------------|-------------------------------------------------------------------------------------------------------------| +| id | The name of the section. Appears as the name in the project sidebar. **Must be unique**. | +| content | Minified string of markdown content. Newlines are replaced with `\n` and `"` with `\"`. | +| type | Section type. One of 4 values: `folder`, `maincontent`, `frontmatter`, `backmatter`. | +| canHaveChildren | `true` or `false` value indicating whether the Section can have children. Only valid for `folder` sections. | +| children | A JSON array of `Section[]`. Only valid for `folder` sections. | +| collapsed | `true` or `false` value indicating whether then section is collapsed. Only valid for `folder` sections. | + + +
+ + +#### 📕 Print-ready PDF and EBook + +Calamus is equipped to format your novel for Print and Ebook publication, with pre-made themes and endless customization. -### :gear: Installation +## :gear: Installation Download the [latest release here](https://github.com/midnightprioriem/calamus/releases). diff --git a/release/app/package.json b/release/app/package.json index fad8df4..d34afa9 100644 --- a/release/app/package.json +++ b/release/app/package.json @@ -1,6 +1,6 @@ { "name": "calamus", - "version": "0.2.0-pre-alpha", + "version": "0.3.0-pre-alpha", "description": "Write and Publish Books with Ease", "main": "./dist/main/main.js", "author": {