Lots of niceities for packaging

Author: CGamesPlay

CONTRIBUTING.md

@@ -0,0 +1,54 @@
+# Contributing to Chronicler
+
+First off, thank you for considering contributing to Chronicler! Chronciler is a small personal project made to fill a specific need for myself, and I'm happy to see that you are interested using it to help your own use case as well.
+
+This document provides some guidelines to ensure that bug reports, pull requests, and other contributions flow smoothly. By following these guidelines, you are signalling to me that you respect my time and energy, and I will reciprocate by showing you the same respect when working with you.
+
+### Project goals
+
+Contributions are most appreciated when they are in line with the project's goals. The goals of Chronicler are, in order:
+
+1. **Chronicler is reliable.** Chronicler must never suffer from data loss. This priority comes before all others in this list.
+2. **Chronicler is easy to use.** All of Chronicler's features should be usable without requiring a manual, and ideally without any training at all.
+3. **Chronicler is fast.** Chronicler should be as fast as possible, but this shouldn't get in the way of reliability or ease of use.
+4. **Chronicler is the ideal tool for personal web archiving.** New features that make Chronicler better for this task are welcomed while features that do not are encouraged to be built as separate software that interoperates with Chronicler.
+
+### How to contribute
+
+Chronicler is very young and there are many ways where it can be improved. In general, contributions that work towards the goals of the project are always welcomed. Some ways that you can help contribute include:
+
+- **Asking for help with a Chronicler issue.** If you can't get a feature to work as expected, then Chronicler isn't being easy to use. Sharing your experience may help resolve the issue, and may help others in the future as well.
+- **Explaining your use case and why Chronicler failed you.** Did the program crash? Is there a feature that doesn't work on a particular site? Sharing your experience with the community can help make the software better. I can't promise I'll be able to implement every feature request, though.
+- **Making a pull request.** Changes that advance the goals of the project are welcomed!
+
+### Code of conduct
+
+- Be civil. Don't say things you wouldn't say face-to-face. Don't be snarky. Comments should get more civil and substantive, not less, as a topic gets more divisive.
+- When disagreeing, please reply to the argument instead of calling names. "That is idiotic; 1 + 1 is 2, not 3" can be shortened to "1 + 1 is 2, not 3."
+- Please respond to the strongest plausible interpretation of what someone says, not a weaker one that's easier to criticize. Assume good faith.
+- Be Open, Considerate, and Respectful as described in the [Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/).
+- This project abides by the [Contributor Covenant](https://www.contributor-covenant.org/version/1/4/code-of-conduct).
+
+## Running Chronicler from source
+
+### Development Scripts
+
+```bash
+# run application in development mode
+yarn dev
+
+# compile source code and create webpack output
+yarn compile
+
+# `yarn compile` & create build with electron-builder
+yarn dist
+
+# `yarn compile` & create unpacked build with electron-builder
+yarn dist:dir
+```
+
+### Useful links
+
+- http://vcap.me/ - this domain always resolves to 127.0.0.1. I use it as a guaranteed offline domain.
+- http://httpstat.us/ - useful for testing different HTTP status codes.
+- https://badssl.com/ - useful for testing different SSL error conditions.

README.md

@@ -1,54 +1,20 @@
-# electron-webpack-quick-start
-> A bare minimum project structure to get started developing with [`electron-webpack`](https://github.com/electron-userland/electron-webpack).
+# Chronicler
+Chronicler is an offline-first web browser. Chronicler works as your own personal:
 
-Thanks to the power of `electron-webpack` this template comes packed with...
+- Web archiver, snapshotting pages exactly as you remember them.
+- Search engine, providing full-text search of all pages you visit.
+- Web crawler, automatically downloading entire sites to be browsed later.
 
-* Use of [`webpack-dev-server`](https://github.com/webpack/webpack-dev-server) for development
-* HMR for both `renderer` and `main` processes
-* Use of [`babel-preset-env`](https://github.com/babel/babel-preset-env) that is automatically configured based on your `electron` version
-* Use of [`electron-builder`](https://github.com/electron-userland/electron-builder) to package and build a distributable electron application
+**📺 Click to watch a brief video showing Chronicler's features:**
 
-Make sure to check out [`electron-webpack`'s documentation](https://webpack.electron.build/) for more details.
+[![Introduction to Chronicler video](https://img.youtube.com/vi/MxEqFmjsZFw/maxresdefault.jpg)](https://youtu.be/MxEqFmjsZFw)
 
 ## Getting Started
-Simply clone down this reposity, install dependencies, and get started on your application.
+Download the latest version from the [releases page](https://github.com/CGamesPlay/chronicler/releases).
 
-The use of the [yarn](https://yarnpkg.com/) package manager is **strongly** recommended, as opposed to using `npm`.
+**⚠️ Warning:** Chronicler is stable but very early in development. Many features you might expect from a web browser have not yet been implemented. Your feedback is welcomed!
 
-```bash
-# create a directory of your choice, and copy template using curl
-mkdir new-electron-webpack-project && cd new-electron-webpack-project
-curl -fsSL https://github.com/electron-userland/electron-webpack-quick-start/archive/master.tar.gz | tar -xz --strip-components 1
+### Contributing
 
-# or copy template using git clone
-git clone https://github.com/electron-userland/electron-webpack-quick-start.git
-cd electron-webpack-quick-start
-rm -rf .git
+Thanks for your interest in contributing! 🙌 There are many ways to contribute to Chronicler. Get started [here](CONTRIBUTING.md).
 
-# install dependencies
-yarn
-```
-
-### Development Scripts
-
-```bash
-# run application in development mode
-yarn dev
-
-# compile source code and create webpack output
-yarn compile
-
-# `yarn compile` & create build with electron-builder
-yarn dist
-
-# `yarn compile` & create unpacked build with electron-builder
-yarn dist:dir
-```
-
-### Useful links
-
-- http://vcap.me/
-- https://cgi-lib.berkeley.edu/ex/fup.html
-- https://httpbin.org/
-- http://httpstat.us/
-- https://badssl.com/

package.json

@@ -1,13 +1,26 @@
 {
-  "name": "electron-webpack-quick-start",
-  "version": "0.0.0",
+  "name": "chronicler",
+  "description": "An offline-first web browser",
+  "version": "1.0.0",
+  "author": {
+    "name": "Ryan Patterson",
+    "email": "[email protected]"
+  },
   "license": "MIT",
   "scripts": {
     "dev": "electron-webpack dev",
     "compile": "electron-webpack",
     "dist": "yarn compile && electron-builder",
     "dist:dir": "yarn dist --dir -c.compression=store -c.mac.identity=null"
   },
+  "build": {
+    "appId": "com.cgamesplay.chronicler",
+    "productName": "Chronicler",
+    "copyright": "Copyright 2018 Ryan Patterson",
+    "mac": {
+      "category": "public.app-category.reference"
+    }
+  },
   "electronWebpack": {
     "renderer": {
       "webpackConfig": "renderer.webpack.config.js"

src/common/config.js

@@ -1,3 +1,3 @@
 // @flow
 
-export const appName = "DocBrowser";
+export const appName = "Chronicler";

src/common/urls.js

@@ -12,6 +12,7 @@ export const contentRoot = isDevelopment
   : "app://main/html";
 export const contentUrl = (path: string) => contentRoot + path;
 
+export const welcomeUrl = "/welcome";
 export const allPagesUrl = "/all-pages";
 export const searchUrl = (query?: string) =>
   query ? `/search?q=${encodeURIComponent(query)}` : "/search";