Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update license, readme and package #42

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+24 −10
Open

Update license, readme and package #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License

Copyright (c) 2014 Adrian Rossouw
Copyright (c) 2014 - 2016 Adrian Rossouw

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
26 changes: 20 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
![build status](https://travis-ci.org/AdrianRossouw/seneca-elasticsearch.svg)
![SenecaLogo][]

elastic search plugin to seneca
# seneca-elasticsearch

elastic search plugin to [Seneca][]

This plugin will automatically index any entities that are being saved.
Only entities will have their fields filtered by options.fields, the
Expand Down Expand Up @@ -47,7 +49,7 @@ seneca.ready(function(err) {
```


## index management api
## Index management api

```JavaScript
// check for index
Expand All @@ -60,7 +62,7 @@ seneca.act({role: 'search', cmd: 'create-index', index: 'myIndex'}, callback);
seneca.act({role: 'search', cmd: 'delete-index', index: 'myIndex'}, callback);
```

## record management api
## Record management api

```JavaScript
// index or update a record
Expand Down Expand Up @@ -96,7 +98,7 @@ seneca.act({
}, callback);
```

## search api
## Search api

```JavaScript
// return all records
Expand Down Expand Up @@ -126,7 +128,7 @@ seneca.act({
// to be using.
```

## testing
## Testing

By default this library maintains a connection to ElasticSearch using a keepAlive. If you use this library as part of your own plugin, depending on the testing library you employ it's possible that your tests never complete because the connection is held open. To disable the keepAlive, do:

Expand All @@ -138,3 +140,15 @@ connection: {
````


## Contributing

The [Senecajs org][] encourage open participation. If you feel you can help in any way, be it with documentation, examples, extra testing, or new features please get in touch.

## License

Copyright Adrian Rossouw and other contributors 2014 - 2016, Licensed under [MIT][].

[SenecaLogo]: https://camo.githubusercontent.com/4a0178ff2abf26f9214d4d98bc23eec356ced357/687474703a2f2f73656e6563616a732e6f72672f66696c65732f6173736574732f73656e6563612d6c6f676f2e706e67
[Seneca]: http://senecajs.org/
[Senecajs org]: https://github.com/senecajs/
[MIT]: ./LICENSE.txt
6 changes: 3 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
},
"repository": {
"type": "git",
"url": "git://github.com/nherment/seneca-elasticsearch.git"
"url": "git://github.com/senecajs-labs/seneca-elasticsearch.git"
},
"keywords": [
"elasticsearch",
Expand All @@ -23,9 +23,9 @@
],
"license": "MIT",
"bugs": {
"url": "https://github.com/nherment/seneca-elasticsearch/issues"
"url": "https://github.com/senecajs-labs/seneca-elasticsearch/issues"
},
"homepage": "https://github.com/nherment/seneca-elasticsearch",
"homepage": "https://github.com/senecajs-labs/seneca-elasticsearch",
"dependencies": {
"async": "0.6.2",
"elastic.js": "1.1.1",
Expand Down