Skip to content
Permalink
Browse files

fix markdown

  • Loading branch information...
sumanbh committed Mar 24, 2017
1 parent 97d9239 commit 7c799cd3181c5418a5bdfd2ff2bff2286ce09ec7
Showing with 16 additions and 16 deletions.
  1. +16 −16 README.md
@@ -1,5 +1,5 @@
#solr-client - a node.js solr client
[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/lbdremy/solr-node-client?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
# solr-client - a node.js solr client
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/lbdremy/solr-node-client?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![](https://secure.travis-ci.org/lbdremy/solr-node-client.png)](http://travis-ci.org/#!/lbdremy/solr-node-client) [![Dependency Status](https://gemnasium.com/lbdremy/solr-node-client.png)](https://gemnasium.com/lbdremy/solr-node-client)

@@ -15,9 +15,9 @@ npm install --save solr-client
```


##Features
## Features

###Latest (0.6.0)
### Latest (0.6.0)

- Solr5 Query-Highlighting support through StandardHighlighter (@LukeTaverne) (https://github.com/lbdremy/solr-node-client/pull/144)
- Experimental support for SolrCloud collections administration (@LukeTaverne) (https://github.com/lbdremy/solr-node-client/issues/138)
@@ -28,7 +28,7 @@ npm install --save solr-client
Noticeable change: You can now pass a solrVersion to the Client initialization so it will activate features that are only supported
by your version or higher. Be sure to check the documentation

###0.5.0
### 0.5.0

- Commands supported: search(select), add, delete, update, commit, rollback, optimize, ping, real-time get, prepare commit, soft commit, arbitrary search handler (i.e: mlt, luke ...)
- Lucene query / DisMax query
@@ -38,11 +38,11 @@ by your version or higher. Be sure to check the documentation
- Over HTTPS as well
- Use json-bigint to handle correctly numbers too large for Javascript Number such as the values of the fields *_l and \_version\_. By default json-bigint library is not used because the performance difference compared to the native JSON library is too important with "large" chunk of JSON (https://github.com/lbdremy/solr-node-client/issues/114#issuecomment-54165595), but you want to enable it if you use the Optimistic Concurreny feature available in Solr 4.x, along with RealTime Get and Atomic Updates features because they use the \_version\_ field. In order to enable it do `var client = solr.createClient({ bigint : true})` or directly on the client instance `client.options.bigint = true`.
##Documentation
## Documentation
See the website at http://lbdremy.github.com/solr-node-client/.
##Usage
## Usage
```js
// Load dependency
@@ -61,7 +61,7 @@ client.add({ id : 12, title_t : 'Hello' },function(err,obj){
});
```
##Migration between 0.5.x and 0.6.x
## Migration between 0.5.x and 0.6.x
No breaking change has been introduced to this release. However, to take advantage of facet.pivot and facet.pivot.mincount feature,
you'll need to pass a solrVersion parameter to the createClient() method.
@@ -90,7 +90,7 @@ var client = solr.createClient({
});
```
##Migration between 0.4.x and 0.5.x
## Migration between 0.4.x and 0.5.x
The only breaking change introduced in `0.5.x` is introduced in this commit [3cbc7fc6cf631f019a4626913c0a4b616092133b](https://github.com/lbdremy/solr-node-client/commit/3cbc7fc6cf631f019a4626913c0a4b616092133b) which remove escaping of the Solr special characters in some of the methods of the `Query` class i.e in `Query#rangeFilter`, `Query#matchFilter`, `Query#group`, `Query#facet`, `Query#mlt` if you were relying on this behavior just wrap the arguments you passed to those methods into the [`solr.escapeSpecialChars(arg)`](https://github.com/lbdremy/solr-node-client/blob/master/lib/solr.js#L605) method.
@@ -110,7 +110,7 @@ query.q({ '*' : '*' }).rangeFilter({ field : 'id', start : 100, end : solr.escap

Post an issue if you have troubles migrating to v0.5.0.

##Migration between 0.3.x and 0.4.x
## Migration between 0.3.x and 0.4.x

The only breaking change introduced in `0.4.x` is about JSON serialization/deserialization of numbers too large for Javascript Number type. If you were using the Optimistic Concurreny feature available in Solr 4.x, along with RealTime Get and Atomic Updates features which use the \_version\_ field or *_l type fields you are affected about this change otherwise you are just fine.
@@ -128,7 +128,7 @@ client.options.bigint = true;
Post an issue if you have troubles migrating to v0.4.0.
##Migration between 0.2.x and 0.3.x
## Migration between 0.2.x and 0.3.x
The only breaking change introduced in `v0.3.0` is about method chaining of the solr `Client`.
Method chaining as simply been removed because we were actually hidding something really interesting and useful
@@ -163,21 +163,21 @@ request.setTimeout(200, function(){
Post an issue if you have troubles migrating to v0.3.0.
##Roadmap
## Roadmap
###v0.3.x - v0.x.x
### v0.3.x - v0.x.x
- Test suite with mocha and chai instead of vows
- Implement all features available in Solr 4 (SolrCloud API in particular)
- Provide all low-level commands
- Complete documentation
###v1.0.x
### v1.0.x
- First stable version
- the API is frozen until v2.0.x, only new features and bug fixes can be introduced
##Test
## Test
```
npm test
@@ -208,7 +208,7 @@ This command will generate a file named `coverage.html`, use your browser to vis
npm run-script report
```
##Licence
## Licence
(The MIT License)

0 comments on commit 7c799cd

Please sign in to comment.
You can’t perform that action at this time.