Skip to content

Commit 20e06c4

Browse files
authored
Merge pull request #91 from pydsigner/version_1.0
Update README.md for v1.0
2 parents 389f6aa + dbfce06 commit 20e06c4

File tree

2 files changed

+24
-10
lines changed

2 files changed

+24
-10
lines changed

README.md

+23-9
Original file line numberDiff line numberDiff line change
@@ -9,34 +9,35 @@
99
Anchovy is a minimal, unopinionated file-processing framework equipped with a
1010
complete static website generation toolkit.
1111

12-
* **Minimal:** Anchovy's core is around a thousand lines of code and has no
12+
* **Minimal:** Anchovys core is around a thousand lines of code and has no
1313
mandatory dependencies. Plus, Anchovy can be used for real projects with just
1414
a few pip-installable extras, even if you want to preprocess CSS.
1515

1616
* **Unopinionated:** Anchovy offers a set of components which can be easily
17-
configured to your site's exact requirements, without tediously ripping out
17+
configured to your sites exact requirements, without tediously ripping out
1818
or overriding entrenched behaviors. Anchovy does not assume you are building
1919
a blog or that you wish to design your templates in a specific way. You can
20-
even build things that aren't websites! Plus, Anchovy operates on files, so
21-
it's simple to integrate tools like imagemagick, dart-sass, or less.js if you
20+
even build things that arent websites! Plus, Anchovy operates on files, so
21+
its simple to integrate tools like imagemagick, dart-sass, or less.js if you
2222
need them.
2323

2424
* **Complete:** Anchovy comes with a dependency auditing system, allowing you
2525
to grab any component you want without installing anything but Anchovy and
2626
find out what you *will* need to run your build. Choose from a wealth of
27-
Steps, Anchovy's modular file processors, for everything from rendering Jinja
27+
Steps, Anchovys modular file processors, for everything from rendering Jinja
2828
templates and minifying CSS to unpacking archives and thumbnailing images.
2929
Plus, add a few extra parameters or lines of configuration to get automatic
3030
intelligent minimum builds based on input checksums, and get a reproducible
3131
run artifact to boot— even if you want to fetch HTTP resources or write your
32-
own Steps.
32+
own Steps. Iterate quickly by launching a lightweight development-grade web
33+
server once the build is complete.
3334

3435
## Installation
3536

3637
Anchovy has no essential prerequisites and can be installed with
3738
`pip install anchovy` to get just the framework and a few built-in components,
3839
but for typical usage `pip install anchovy[base]` is recommended. This will
39-
pull in support for Jinja2 templating, markdown, minification, and Anchovy's
40+
pull in support for Jinja2 templating, markdown, minification, and Anchovys
4041
CSS preprocessor. A full list of available extras may be found in the
4142
[pyproject.toml](./pyproject.toml) file.
4243

@@ -52,6 +53,17 @@ Anchovy operates on config files written in Python, or even modules directly.
5253
* `anchovy -m mypackage.anchovyconf -o ../release/`
5354
* `python -m anchovy mysite/anchovy_site.py -- -h`
5455

56+
### Show Me
57+
58+
Run `anchovy examples/code_index.py -s -p 8080`, then open a browser to
59+
localhost:8080 (or click the link in the console). This example offers the most
60+
extensive demonstration of Anchovy’s functionality as of version 1.0.
61+
62+
### What’s the Baseline?
63+
64+
Here’s minimal example performing about what the `staticjinja` markdown example
65+
offers:
66+
5567
```python
5668
from pathlib import Path
5769

@@ -96,8 +108,10 @@ RULES = [
96108
]
97109
```
98110

99-
This example is very simple, but is legitimately enough for a small website.
100-
If we stored the configuration in `config.py` and added a raw site like this:
111+
This example is very simple, but it’s legitimately enough to start with for a
112+
small website, and offers an advantage over other minimal frameworks by putting
113+
additional batteries within an arm’s reach. If we stored the configuration in
114+
`config.py` and added a raw site like this:
101115
```
102116
site/
103117
static/

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ authors = [
1313
]
1414
keywords = ["static", "website", "generation", "html", "css", "template"]
1515
classifiers = [
16-
"Development Status :: 3 - Alpha",
16+
"Development Status :: 4 - Beta",
1717
"Intended Audience :: Developers",
1818
"License :: OSI Approved :: Apache Software License",
1919
"Operating System :: OS Independent",

0 commit comments

Comments
 (0)