on master help sign in
Add high-level description to README
8298aebElliot Cameron
README.md+15−2
@@ -3,9 +3,11 @@
3[![Haskell Programming Language](https://img.shields.io/badge/language-Haskell-blue.svg)](http://www.haskell.org)
3[![Haskell Programming Language](https://img.shields.io/badge/language-Haskell-blue.svg)](http://www.haskell.org)
4[![BSD3 License](http://img.shields.io/badge/license-BSD3-brightgreen.svg)](https://tldrlegal.com/license/bsd-3-clause-license-%28revised%29)
4[![BSD3 License](http://img.shields.io/badge/license-BSD3-brightgreen.svg)](https://tldrlegal.com/license/bsd-3-clause-license-%28revised%29)
5
5
6+Obelisk is an opinionated, batteries-included framework for building production-ready web and mobile applications in [Haskell](https://www.haskell.org/). It's goal is to represent a cohesive, highly-curated set of choices that [Obsidian Systems](https://obsidian.systems/) has made for building these types of applications in a way that is extremely fast but does not compromise on production readiness.
6
7
7−Obelisk provides an easy way to develop and deploy your [Reflex](https://github.com/reflex-frp/reflex) project as web apps and as mobile apps.
8+- [Overview](#installing-obelisk)
8−
9+ - [Why would I use it?](#why-would-i-use-it)
10+ - [Who should consider using it?](#who-should-consider-using-it)
9- [Installing Obelisk](#installing-obelisk)
11- [Installing Obelisk](#installing-obelisk)
10- [Developing an Obelisk project](#developing-an-obelisk-project)
12- [Developing an Obelisk project](#developing-an-obelisk-project)
11 - [Adding Packages](#adding-packages)
13 - [Adding Packages](#adding-packages)
@@ -25,7 +27,18 @@ Obelisk provides an easy way to develop and deploy your [Reflex](https://github.
25 - [iOS](#ios)
27 - [iOS](#ios)
26 - [Android](#android)
28 - [Android](#android)
27
29
30+## Overview
31+
32+### Why would I use it?
33+
34+Obelisk allows you to build high-quality, high-performance web and mobile applications very quickly using [Reflex](https://reflex-frp.org/). In minutes you can go from an empty directory to a working prototype of an interactive application that works on web, iOS, and Android, all sharing the same Haskell codebase! Obelisk's development environment also enables extremely rapid prototyping and feedback. You can take advantage of Haskell's type system across the frontend and backend boundary. This means changes to your backend that would break your frontend are immediately detected during development and Haskell's compiler is able to give you a complete "TODO" list of what needs to be updated.
35+
36+### Who should consider using it?
37+
38+Obelisk is targeted primarily at Haskell developers who want to build high-quality web and/or mobile applications in Haskell without the distractions of manually choosing and integrating technology for every piece of the system.
39+
28## Installing Obelisk
40## Installing Obelisk
41+
291. [Install Nix](https://nixos.org/nix/).
421. [Install Nix](https://nixos.org/nix/).
30 If you already have Nix installed, make sure you have version 2.0 or higher. To check your current version, run `nix-env --version`.
43 If you already have Nix installed, make sure you have version 2.0 or higher. To check your current version, run `nix-env --version`.
311. Set up nix caches
441. Set up nix caches