Skip to content

Commit

Permalink
update changelog and readme for 3.4.3
Browse files Browse the repository at this point in the history
  • Loading branch information
rjrodger committed Oct 13, 2017
1 parent 89bc850 commit 4971f06
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 25 deletions.
6 changes: 6 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## 3.4.3 2017-10-13

* Supports --seneca.test to trigger test mode
* Support SENECA_TEST enviroment variable


## 3.4.2 2017-08-10

* Fixes priors bug #662
Expand Down
74 changes: 49 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,13 @@
[![Gitter][BadgeGitter]][Gitter]

- __Lead Maintainer:__ [Richard Rodger][Lead]
- __Sponsor:__ [nearForm][Sponsor]
- __Sponsor:__ [metsitaba][Sponsor]
- __Node:__ 4.x, 6.x, 8.x

Seneca is a toolkit for writing microservices and organizing the business logic of your
app. You can break down your app into "stuff that happens", rather than focusing on data
models or managing dependencies.
Seneca is a toolkit for writing microservices and organizing the
business logic of your app. You can break down your app into "stuff
that happens", rather than focusing on data models or managing
dependencies.

Seneca provides,

Expand All @@ -23,17 +24,18 @@ Seneca provides,
- __transport independence:__ how messages get to the right server is not something you
should have to worry about

- __maturity:__ 5 years in production (before we called it _microservices_), but was
- __maturity:__ 7 years in production (before we called it _microservices_), but was
once taken out by [lightning][]

- __plus:__ a deep and wide ecosystem of [plugins][]

Use this module to define commands that work by taking in some JSON, and, optionally,
returning some JSON. The command to run is selected by pattern-matching on the the input
JSON. There are built-in and optional sets of commands that help you build Minimum Viable
Products: data storage, user management, distributed logic, caching, logging, etc. And you
can define your own product by breaking it into a set of commands - "stuff that happens".
That's pretty much it.
Use this module to define commands that work by taking in some JSON,
and, optionally, returning some JSON. The command to run is selected
by pattern-matching on the the input JSON. There are built-in and
optional sets of commands that help you build Minimum Viable Products:
data storage, user management, distributed logic, caching, logging,
etc. And you can define your own product by breaking it into a set of
commands - "stuff that happens". That's pretty much it.

If you're using this module, and need help, you can:

Expand All @@ -54,19 +56,6 @@ To install via npm,
npm install seneca
```

## Test
To run tests locally,

```
npm run test
```

To obtain a coverage report,

```
npm run coverage; open docs/coverage.html
```

## Quick Example

```js
Expand Down Expand Up @@ -146,6 +135,24 @@ Seneca()
```


## Running

To run normally, say in a container, use

```sh
$ node microservice.js
```

(where `microservice.js` is a script file that uses Seneca).
Logs are output in JSON format so you can send them to a logging service.

To run in test mode, with human-readable, full debug logs, use:

```
$ node microservice.js --seneca.test
```


## Why we built this?

So that it doesn't matter,
Expand Down Expand Up @@ -352,11 +359,28 @@ isolate complexity into well-defined places. It also means you can deal with spe
cases very easily.

## Contributing

The [Senecajs org][Org] encourages participation. If you feel you can help in any way, be
it with bug reporting, documentation, examples, extra testing, or new features feel free
to [create an issue][Issue], or better yet, [submit a [Pull Request][Pull]. For more
information on contribution please see our [Contributing][Contrib] guide.


### Test
To run tests locally,

```
npm run test
```

To obtain a coverage report,

```
npm run coverage; open docs/coverage.html
```



## License
Copyright (c) 2015-2016 Richard Rodger and other contributors;
Licensed under __[MIT][Lic]__.
Expand All @@ -379,7 +403,7 @@ Licensed under __[MIT][Lic]__.
[Npm]: https://www.npmjs.com/package/seneca
[Org]: http://senecajs.org/
[Pull]: https://github.com/senecajs/seneca/pulls
[Sponsor]: http://nearform.com
[Sponsor]: http://www.metsitaba.com
[Travis]: https://travis-ci.org/senecajs/seneca?branch=master
[Tweet]: https://twitter.com/senecajs

Expand Down

0 comments on commit 4971f06

Please sign in to comment.