v1.0, add README

Project.toml

@@ -1,6 +1,6 @@
 name = "BlockArrays"
 uuid = "8e7c35d0-a365-5155-bbbb-fb81a777f24e"
-version = "1.0.0-dev"
+version = "1.0.0"
 
 [deps]
 ArrayLayouts = "4c555306-a7a7-4459-81d9-ec55ddd5c99a"

README.md

@@ -14,6 +14,8 @@ Secondly, it also implements two different type of block arrays that follow the
 
 A simple way to produce `BlockArray`s is via `mortar`, which combines an array of arrays into a `BlockArray`:
 ```julia
+julia> using BlockArrays
+
 julia> mortar([randn(3), randn(4)])
 2-blocked 7-element BlockVector{Float64}:
  -0.19808699390960527
@@ -33,11 +35,41 @@ julia> mortar(reshape([randn(2,2), randn(1,2), randn(2,3), randn(1,3)],2,2))
   0.430093  -0.0263753  │  -1.31275     0.278447  -0.139579
 ```
 
+Alternatively, one can add block structure on top of an existing array by wrapping the array in  `BlockedArray`, where the extra arguments give the sizes of the blocks:
+```julia
+julia> BlockedArray(randn(7), [3,4])
+2-blocked 7-element BlockedVector{Float64}:
+ -0.17348560551451797
+ -0.5680124317024628
+  1.699007590285868
+ ─────────────────────
+ -0.7437814954416642
+ -0.018198226033108045
+  1.3335354818213445
+ -0.03512135185007728
+
+julia> BlockedArray(randn(3,5), [2,1], [2,3])
+2×2-blocked 3×5 BlockedMatrix{Float64}:
+  0.444186   0.788823  │   0.743428  -0.815026   0.715779
+ -0.721074  -0.43783   │   1.07413   -0.336926   0.539873
+ ──────────────────────┼─────────────────────────────────
+  0.128836  -0.350202  │  -2.71365    1.67605   -0.25611
+```
+
+
 ## Documentation
 
 - [**STABLE**][docs-stable-url] — **most recently tagged version of the documentation.**
 - [**LATEST**][docs-dev-url] — *in-development version of the documentation.*
 
+## Changes in v1.0
+
+We are excited to release v1.0! There are some important breaking changes from previous versions of BlockArrays.jl:
+
+- `BlockedArray` replaces `PseudoBlockArray`.
+- Axes are now typically `BlockedOneTo` instead of `BlockUnitRange`.
+- Support for some simple block-banded matrices has been moved here from BlockBandedMatrices.jl
+
 ## Contributing
 
 Possible ways of contributing to this package include: