Update README, add LICENSE

.buildkite/pipeline.yml

@@ -3,7 +3,7 @@ steps:
   - label: ":julia: Run tests on Julia LTS"
     plugins:
       - JuliaCI/julia#v1:
-          version: 1.6
+          version: 1.10
       - JuliaCI/julia-test#v1:
     command: |
       julia -e 'using Pkg;

.github/workflows/ci.yml

@@ -15,8 +15,8 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - "1"    # Latest Release
-          - "1.6"  # LTS
+          - "1"     # Latest Release
+          - "1.10"  # LTS
         os:
           - ubuntu-latest
           - macOS-latest
@@ -31,12 +31,12 @@ jobs:
           - os: windows-latest
             arch: x86
     steps:
-      - uses: actions/checkout@v2
-      - uses: julia-actions/setup-julia@v1
+      - uses: actions/checkout@v5
+      - uses: julia-actions/setup-julia@v2
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
-      - uses: actions/cache@v2
+      - uses: actions/cache@v4
         env:
           cache-name: cache-artifacts
         with:

.github/workflows/documentation.yml

@@ -11,10 +11,10 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v5
       - uses: julia-actions/setup-julia@latest
         with:
-          version: '1.6'
+          version: '1.10'
       - name: Install dependencies
         run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
       - name: Build and deploy

LICENSE.md

@@ -0,0 +1,17 @@
+GNU GENERAL PUBLIC LICENSE
+Version 3, 29 June 2007
+
+Copyright (C) 2025 Jonathan Salmerón-Hernández and Pablo Zubieta-Rico
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.

README.md

@@ -1,6 +1,12 @@
-# LiquidsCrystals.jl
+# LiquidCrystals.jl
 
-Library to solve the Landau-de Gennes model for nematic liquid crystals.
+**LiquidCrystals.jl** is an open-source Julia package for simulating the GENERIC concentration-dependent nematohydrodynamic equations of liquid crystals, providing researchers with a reproducible, efficient, and flexible tool for studying binary mixtures of liquid crystals.
+
+## Features
+
+- Finite-difference upwind schemes for concentration and tensorial liquid-crystal ordering
+- Galerkin Lattice Boltzmann methods for mass and momentum balance in combination with **Trixi.jl**
+- Open-source, designed for reproducibility and community use.
 
 ## Installation
 
@@ -12,10 +18,64 @@ julia> ]
 pkg> dev https://github.com/depablogroup/LiquidCrystals.jl.git
 ```
 
+
 ## Dependencies
 
 The Finite Element aspect will be handled through `Gridap.jl`
 
 ## Usage
 
-Look at the `examples/notbooks` folder to see the library in action.
+Examples and notebooks demonstrating the library can be found in the `examples/notebooks` folder.
+
+## Examples
+
+### Binary mixture with topological defects
+The figure below shows a simulated binary mixture: two isotropic droplets immersed in a nematic environment.  
+
+
+<p align="center">
+  <img src="assets/Picture8b.png" width="500"/>
+  <br><i>Figure: Two isotropic droplets immersed in a nematic environment. Director vectors (white lines) and scalar order parameter (color map 0–0.75).</i>
+</p>
+
+---
+
+### Droplet under semi-Couette flow
+The figures below show the evolution of an axial droplet immersed in an isotropic fluid under semi-Couette flow.  
+- Left: director vectors (gray lines, scaled according to order parameter values) and scalar order parameter (color map 0–0.8).  
+- Top right: concentration profile (color map 0–1).  
+- Bottom right: velocity profile (x-component from -0.07 to 0.07).  
+
+<p align="center">
+  <img src="assets/Picture9.png" width="220"/>
+  <img src="assets/Picture10.png" width="220"/>
+  <img src="assets/Picture11.png" width="220"/>
+  <img src="assets/Picture12.png" width="220"/>
+  <br><i>Figures: Time evolution of an axial droplet under semi-Couette flow. Successive time steps from initial conditions to final state.</i>
+</p>
+
+---
+
+### Droplet under parabolic flow
+The figure below shows a snapshot of an axial droplet simulation immersed in an isotropic fluid under parabolic (Poiseuille-like) flow.  
+
+<p align="center">
+  <img src="assets/Picture16.png" width="500"/>
+  <br><i>Figure: Axial droplet under parabolic flow. Director vectors (gray lines), scalar order parameter, concentration and velocity profile shown.</i>
+</p>
+
+---
+
+### Active nematic
+The figure below shows a snapshot of an active nematic system.  
+
+<p align="center">
+  <img src="assets/Picture22.png" width="500"/>
+  <br><i>Figure: Active nematic snapshot. Director vectors, scalar order parameter and velocity field shown.</i>
+</p>
+
+---
+
+## Citation
+
+If you use this package in your research, please cite the repository and relevant publications associated with LiquidCrystals.jl.

assets/.gitkeep

@@ -0,0 +1 @@
+