Skip to content

Commit 2625d4b

Browse files
committed
Correct docs for React.createElement. Add Changelog. Update license to be the same as React
1 parent 37f28ae commit 2625d4b

File tree

4 files changed

+21
-6
lines changed

4 files changed

+21
-6
lines changed

CHANGELOG.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
5+
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
6+
7+
## [1.0.1] - 2017-08-20
8+
### Fixed
9+
- Typo in documentation for `React.createElement/3`
10+
11+
## [1.0.0] - 2017-08-19
12+
### Added
13+
- `React.HTML` module for defining HTML React macros
14+
- `React` FFI module with `createElement/3`
15+
- `ReactDOM` FFI module with `render/2`

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ElixirScriptReact
22

3-
A library for using React with ElixirScript
3+
A library for using [React](https://facebook.github.io/react/) with ElixirScript
44

55
## Example
66

lib/react.ex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
defmodule React do
22
@moduledoc """
3-
FFI Module for interacting with the React
3+
FFI Module for interacting with the [React](https://facebook.github.io/react/)
44
JavaScript module.
55
"""
66
use ElixirScript.FFI
@@ -9,7 +9,7 @@ defmodule React do
99
Creates a React Element
1010
1111
```elixir
12-
props = ElixirScript.JS.map_to_object(%{"hello" => world})
12+
props = %{"hello" => world}
1313
children = []
1414
1515
React.createElement("div", props, children)

mix.exs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ defmodule ElixirScriptReact.Mixfile do
44
def project do
55
[
66
app: :elixir_script_react,
7-
version: "1.0.0-react.15.6.1",
7+
version: "1.0.1-react.15.6.1",
88
elixir: "~> 1.5",
99
start_permanent: Mix.env == :prod,
1010
deps: deps(),
@@ -34,9 +34,9 @@ defmodule ElixirScriptReact.Mixfile do
3434

3535
defp package do
3636
[
37-
files: ["lib", "priv/**/*.*", "mix.exs", "README.md"],
37+
files: ["lib", "priv/**/*.*", "mix.exs", "README.md", "CHANGELOG.md"],
3838
maintainers: ["Bryan Joseph"],
39-
licenses: ["MIT"],
39+
licenses: ["BSD-3"],
4040
links: %{
4141
"GitHub" => "https://github.com/elixirscript/elixirscript_react"
4242
},

0 commit comments

Comments
 (0)