Skip to content

Commit

Permalink
Merge pull request #192 from amperser/website-copy
Browse files Browse the repository at this point in the history
Improve website copy
  • Loading branch information
suchow committed Sep 28, 2015
2 parents a43631e + 6279108 commit 7519c7b
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 10 deletions.
4 changes: 0 additions & 4 deletions site/_posts/2014-06-10-approach.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ summary: An API for proselint.
categories: proselint api
---

Writing is notoriously hard, even for the best writers. Yet there is a tremendous amount of knowledge about the discipline strewn across usage guides, dictionaries, technical manuals, essays, pamphlets, websites, and the hearts and minds of great authors and editors. But poring over Strunk & White hardly makes one a better writers — it turns you into neither Strunk nor White. And nobody has the willpower (nor the time, memory, or desire) to do what is necessary to apply all the advice from Garner’s Modern American Usage, a 975-page usage guide, to everything that they write. The format of the knowledge is essentially inert, and the method of adoption demanded by that format — reading the advice and, in doing so, becoming a better writer — rests on assumptions about learning and memory that are untenable.

By considering the learner’s cognitive constraints, we devised a solution: <tt>proselint</tt>, a linter for prose. (A linter is a computer program that, like spellcheck, scans through a document and analyzes it.)

<p>Is <tt>proselint</tt> yet another awful grammar checker?</p>
<p><em>No</em>. Here&rsquo;s why not:</p>
<ol>
Expand Down
7 changes: 7 additions & 0 deletions site/_posts/2014-06-10-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@ categories: proselint tools
## Email autoresponder
Send an email to <tt>editor@proselint.com</tt>, or CC the address on an email to someone else. We'll respond with a list of comments based on the linter's output.

## Live web editor
You can play with <tt>proselint</tt> using our <a href="/write">live web editor</a>.

## The web API.
There is a web API, but we haven't released it yet.


<hr/>

For questions and feature requests, write to us at <a href="mailto:hello@proselint.com">hello@proselint.com</a>.
2 changes: 1 addition & 1 deletion site/_posts/2015-09-25-contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ summary: How to contribute to Proselint.
categories: proselint contributors
---

Interested in contributing to <tt>proselint</tt>? Great &mdash; there are plenty of ways you can help. In the following sections, we describe how you can help us build <tt>proselint</tt> into the greatest writing tool in the world.
Interested in contributing to <tt>proselint</tt>? Great &mdash; there are plenty of ways you can help. In the following sections, we describe how you can help us build <tt>proselint</tt> into the greatest writing tool in the world. Work on <tt>proselint</tt> happens over <a href="http://github.com/amperser/proselint/">on Github</a>

## Coding
Have coding skills? You can:
Expand Down
11 changes: 6 additions & 5 deletions site/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,22 @@
<div class="home">
<h1>A linter for prose.</h1>

<p><tt>proselint</tt> places the world&rsquo;s greatest writers and editors by your side, where they whisper suggestions on how to improve your prose. You&rsquo;ll be guided by Bryan Garner, David Foster Wallace, Chuck Palahniuk, Steve Pinker, Mary Norris, Mark Twain, Elmore Leonard, George Orwell, Matthew Butterick, William Strunk, E.B. White, Philip Corbett, Ernest Gowers, and the editorial staff of the world&rsquo;s finest literary magazines and newspapers. Others are on their way and will arrive soon. Our goal is to aggregate knowledge about best practices in writing and to make that knowledge immediately accessible to all authors in the form of a linter for prose. We call it <tt>proselint</tt>.</p>
<p>Writing is notoriously hard, even for the best writers. Yet there is a tremendous amount of knowledge about the discipline strewn across usage guides, dictionaries, technical manuals, essays, pamphlets, websites, and the hearts and minds of great authors and editors. But poring over Strunk &amp; White hardly makes one a better writer — it turns you into neither Strunk nor White. And nobody has the capacity to apply all the advice from <em>Garner’s Modern American Usage</em>, a 975-page usage guide, to everything they write. In fact, the whole notion that one becomes a better writer by reading advice on writing rests on untenable assumptions about learning and memory. The traditional formats of knowledge about writing are thus essentially inert, waiting to be extracted and transformed.</p>

<p><tt>proselint</tt> is a command-line utility and web API that is meant to be integrated into other tools. It&rsquo;s free for personal use. Commercial licenses are available.</p>
<p>We devised a simple solution: <tt>proselint</tt>, a linter for prose. (A linter is a computer program that, like a spell checker, scans through a document and analyzes it.)</p>

<p>With time, <tt>proselint</tt> will become fast, precise, exhaustive, and authoritative. Eventually, it will be unthinkable to write without it by your side.</p>
<p><tt>proselint</tt> places the world&rsquo;s greatest writers and editors by your side, where they whisper suggestions on how to improve your prose. You&rsquo;ll be guided by advice inspired by Bryan Garner, David Foster Wallace, Chuck Palahniuk, Steve Pinker, Mary Norris, Mark Twain, Elmore Leonard, George Orwell, Matthew Butterick, William Strunk, E.B. White, Philip Corbett, Ernest Gowers, and the editorial staff of the world&rsquo;s finest literary magazines and newspapers, among others. Our goal is to aggregate knowledge about best practices in writing and to make that knowledge immediately accessible to all authors in the form of a linter for prose.</p>

<p>Currently, <tt>proselint</tt> is a command-line utility that is meant to be integrated into other tools. There&rsquo;s a plugin for Sublime Text and a <a href="/write">live demo</a>. It&rsquo;s open-source software available under the permissive BSD license. Work on <tt>proselint</tt> happens over <a href="http://github.com/amperser/proselint/">on Github</a>. We welcome <a href="/contributing">contributors.</a></p>

<p>Sign up for access to the private beta below, or write to us at <a href="mailto:hello@proselint.com">hello@proselint.com</a>. We&rsquo;d love to chat.</p>
<p>With time, <tt>proselint</tt> will become fast, precise, exhaustive, and authoritative. Eventually, it will be unthinkable to write without it by your side.</p>

<hr/>

<p>For more information, see:</p>
<ul>
<li><a href="/approach">Is <tt>proselint</tt> yet another awful grammar checker?</a></li>
<li><a href="/checks">What <tt>proselint</tt> checks.</a></li>
<li><a href="/api">The web API.</a></li>
<li><a href="/utility">The command-line utility.</a></li>
<li><a href="/tools"><tt>proselint</tt>-based tools and services.</a></li>
</ul>
Expand Down

0 comments on commit 7519c7b

Please sign in to comment.