Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
singularityhacker authored Jan 23, 2021
1 parent 5b4ed4c commit 85f56a8
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
# JAMBook

Don't break the chain! :chains:  :writing_hand:
Don't break the chain! :chains:  :writing\_hand:

JAMBook is a project for people who want to use GitHub as their primary writing environment. All articles are written as basic markdown files and there is a calendar to help you not break the chain of your daily writing goal. It's deployable to Netlify and the word count function runs as a GitHub action so there is nothing for you to install or run locally.

![](https://user-images.githubusercontent.com/1808235/105616964-e69efc80-5da8-11eb-90a7-c4a5575ce029.png)

## Use

1. Click “Use this template” at the top of this page and name your copy whatever you want.
2. Login into [Netlify](https://www.netlify.com/) and click “New site from Git” and select the repo you just created.
3. Start created and editing your .md files in the `src/posts` folder
4. Every time you commit your changes, the work count script will run and the updated site will be redeployed to Netlify
1. Click “Use this template” at the top of this page and name your copy whatever you want.
2. Login into [Netlify](https://www.netlify.com/) and click “New site from Git” and select the repo you just created.
3. Start created and editing your .md files in the `src/posts` folder
4. Every time you commit your changes, the work count script will run and the updated site will be redeployed to Netlify

## Running Locally

Expand Down Expand Up @@ -47,7 +49,6 @@ To connect the blog post articles correctly, you have to add frontmatter metadat
title: 'Example post'
slug: 'example-post'
---

```

This will make your blog post available under a unique url based on the slug like: `/blog/example-post`.
Expand All @@ -64,6 +65,6 @@ The single source of truth for the word count changes which are displayed on the

## Handy extensions if writing through the browser

- [Grammarly](https://chrome.google.com/webstore/detail/grammarly-for-chrome/kbfnbcaeplbcioakkpcpgfkobkghlhen?hl=en)
- [Speech to text](https://chrome.google.com/webstore/detail/voice-in-voice-typing/pjnefijmagpdjfhhkpljicbbpicelgko?hl=en)
- [Rich text](https://chrome.google.com/webstore/detail/github-writer/diilnnhpcdjhhkjcbdljaonhmhapadap?hl=en-US)
* [Grammarly](https://chrome.google.com/webstore/detail/grammarly-for-chrome/kbfnbcaeplbcioakkpcpgfkobkghlhen?hl=en)
* [Speech to text](https://chrome.google.com/webstore/detail/voice-in-voice-typing/pjnefijmagpdjfhhkpljicbbpicelgko?hl=en)
* [Rich text](https://chrome.google.com/webstore/detail/github-writer/diilnnhpcdjhhkjcbdljaonhmhapadap?hl=en-US)

0 comments on commit 85f56a8

Please sign in to comment.