Skip to content

Commit

Permalink
fix: stop advertising map in docs as it will be deprecated in v5
Browse files Browse the repository at this point in the history
  • Loading branch information
customcommander committed Jul 20, 2021
1 parent dbb613d commit 95c2b2d
Showing 1 changed file with 0 additions and 28 deletions.
28 changes: 0 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,34 +51,6 @@ ER -
</script>
```


## Mapping Tag

RIS tags are quite terse. They can be mapped to human-friendly names:

```javascript
const RIS = require('@customcommander/ris');

RIS(`
TY - JOUR
AB - this is my abstract
ER -
`);
//=> [{TY: "JOUR", AB: "this is my abstract"}]

// vs

RIS.map(`
TY - JOUR
AB - this is my abstract
ER -
`);
//=> [{'@type': "Journal", abstract: "this is my abstract"}]
```

See the complete [map for each type of RIS reference](https://github.com/customcommander/ris/blob/master/resources/fields-map.csv).


## Reference Types

See [list of reference types](https://github.com/customcommander/ris/blob/master/resources/types.csv). (Based on the [RIS format].)
Expand Down

0 comments on commit 95c2b2d

Please sign in to comment.