Skip to content

Commit

Permalink
Merge pull request #5 from TransbankDevelopers/chore/prepare-release-2.0
Browse files Browse the repository at this point in the history
Prepare release 2.0
  • Loading branch information
gdespirito authored Sep 27, 2020
2 parents 4dc8de0 + f3d6001 commit 095f0a8
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 6 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ Todos los cambios notables a este proyecto serán documentados en este archivo.
El formato está basado en [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
y este proyecto adhiere a [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [2.0.0] - 2020-09-26
### Updated
- Este SDK fue reescrito casi en su totalidad, ya que ahora usa un agente construido en Electron y Node.js, que es más
simple de instalar y entrega un API de Websockets utilizando socket.io.

## [1.2.0] - 2020-07-22
### Added
- Add ability to use the library usins a script tag on the html and via unpkg.com
Expand Down
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@
Este proyecto es parte del SDK Web para POS integrado.
Este SDK, junto con [Este servicio Cliente](https://github.com/TransbankDevelopers/transbank-pos-sdk-web-client) permite conectar tu software web (punto de venta, etc) al servicio

Este README tiene las instrucciones para la versión 2.0 de este SDK. Para la versión 1.0 revisar los tags de este repositorio.

## SDK Web POS Integrado
Este SDK Web consta de dos partes:

[Cliente](https://github.com/TransbankDevelopers/transbank-pos-sdk-web-client): Este cliente se debe instalar e inicializar en el computador que tendrá el equipo POS conectado físicamente. Al instalar e inicializar este servicio, se creará un servidor de websockets local en el puerto 8090, que permitirá, a través del SDK de javascript, poder enviar y recibir mensajes al equipo POS, de manera simple y transparente.
[Agente](https://github.com/TransbankDevelopers/transbank-pos-sdk-web-agent): Este agente es un programa que se debe instalar e inicializar en el computador que tendrá el equipo POS conectado físicamente. Al instalar e inicializar este servicio, se creará un servidor de websockets local en el puerto `8090` que permitirá, a través del [SDK de Javascript](https://github.com/TransbankDevelopers/transbank-pos-sdk-web-js), poder enviar y recibir mensajes del equipo POS, de manera simple y transparente.
[SDK Javascript](https://github.com/TransbankDevelopers/transbank-pos-sdk-web-js) **(este repositorio)**: Este SDK se debe instalar en el software de caja (o cualquier software web que presente HTML, CSS y JS en un navegador web). Este SDK entrega una interfaz simple para conectarse con el cliente, de manera que se puedan mandar instrucciones al POS con un API fácil de usar.


Expand Down Expand Up @@ -33,7 +35,7 @@ POS.connect(ports).then(() => {
### Inscrustando un tag script
Si no usas NPM
```html
<script src="https://unpkg.com/transbank-pos-sdk-web@1/dist/pos.js"></script>
<script src="https://unpkg.com/transbank-pos-sdk-web@2/dist/pos.js"></script>
<script>
Transbank.POS.connect().then(function() {
console.log('Conectado al cliente')
Expand All @@ -48,8 +50,10 @@ Si no usas NPM
})
</script>
```
Nota que la URL https://unpkg.com/transbank/transbank-sdk-web@1/dist/pos.js cargará la ultima versión 1.x.x disponible. De esa forma te asegurarás de tener las últimas correcciones y nuevas funcionalidades (retrocompatibles) de manera automática.
En caso de que quieras definir manualmente la versión instalada, puedes cambiar el `@1` por algo como `@1.1.2`
Nota que la URL https://unpkg.com/transbank/transbank-sdk-web@2/dist/pos.js cargará la ultima versión 1.x.x disponible. De esa forma te asegurarás de tener las últimas correcciones y nuevas funcionalidades (retrocompatibles) de manera automática.
En caso de que quieras definir manualmente la versión instalada, puedes cambiar el `@2` por algo como `@2.0.1`



## Documentación

Expand All @@ -65,7 +69,7 @@ La documentación relevante para usar este SDK es:

## Información para contribuir y desarrollar este SDK

### Standares
### Estándares

- Para los commits respetamos las siguientes normas: https://chris.beams.io/posts/git-commit/
- Usamos ingles, para los mensajes de commit.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "transbank-pos-sdk-web",
"version": "1.0.0",
"version": "2.0.0",
"description": "SDK Web Transbank POS",
"main": "dist/pos.js",
"module": "src/pos.js",
Expand Down

0 comments on commit 095f0a8

Please sign in to comment.