🔖 Relase Buruma 0.1.0

This commit updates the README to be adjusted to the current source code of Buruma and its documentation, in addition it adds another useful sections. The version has been updated in the package.json and the changelog has been written thanks to gitmoji-changelog.
ivanhercaz · Dec 10, 2019 · ad15323 · ad15323
1 parent 49d26a2
commit ad15323
Show file tree

Hide file tree

Showing 3 changed files with 116 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,95 @@
+# Changelog
+
+<a name="0.1.0"></a>
+## 0.1.0 (2019-12-09)
+
+### Changed
+
+- 💬 Change href attribute of the logo [[31cf3d7](https://github.com/ivanhercaz/buruma/commit/31cf3d7af3a3114e4bd05760877fa9014b1cb7fb)]
+- 🍱 Update Buruma logo [[c4c998f](https://github.com/ivanhercaz/buruma/commit/c4c998fe4925fca757c73a15c89d1c9f19bc9771)]
+- ⚡ Add minified CSS (fix [#12](https://github.com/ivanhercaz/buruma/issues/12)) [[3f1f518](https://github.com/ivanhercaz/buruma/commit/3f1f5181e577aeadfd79ed3258c46556d824ed43)]
+ 🎨 Add if to use Buruma logo if not THEME_LOGO ([#4](https://github.com/ivanhercaz/buruma/issues/4)) [[a905301](https://github.com/ivanhercaz/buruma/commit/a9053011790f87c7aadac993002af4ca96d79da5)]
+- 🍱 Add Pelican and Buruma logos to images folder [[83a308e](https://github.com/ivanhercaz/buruma/commit/83a308e16c7d70ca55f2630a3d670a42b6d3597d)]
+- 💄 Adapt color vars in navbar and tags elements [#5](https://github.com/ivanhercaz/buruma/issues/5) [[a47520d](https://github.com/ivanhercaz/buruma/commit/a47520de390b874fd2af3f63c56026a5ccd3848c)]
+- 💄 Change colors between $info and $link ([#5](https://github.com/ivanhercaz/buruma/issues/5)) [[e99f8a2](https://github.com/ivanhercaz/buruma/commit/e99f8a28e460c38a44054b4a43b3c5ba0359474f)]
+- 💄 Add template to handle 404 error ([#1](https://github.com/ivanhercaz/buruma/issues/1)) [[92d8e4a](https://github.com/ivanhercaz/buruma/commit/92d8e4a3254c61c62f16408e1ffe3344b409a671)]
+- 💄 Add template to list authors ([#1](https://github.com/ivanhercaz/buruma/issues/1)) [[6f18a7f](https://github.com/ivanhercaz/buruma/commit/6f18a7f8ca85a92108cf77a28873abc8dc3c9f66)]
+- 💄 Add template to list arts. categorized in ([#1](https://github.com/ivanhercaz/buruma/issues/1)) [[548bac2](https://github.com/ivanhercaz/buruma/commit/548bac2e071415d8fb6dc191d0420e390f4a6d7e)]
+- 💄 Add template to list articles tagged with ([#1](https://github.com/ivanhercaz/buruma/issues/1)) [[6a67a3a](https://github.com/ivanhercaz/buruma/commit/6a67a3a6b9e50f501abbfcea0091c864835ef861)]
+- 💄 Add template to list articles by one user ([#1](https://github.com/ivanhercaz/buruma/issues/1)) [[9028ccf](https://github.com/ivanhercaz/buruma/commit/9028ccf2b5b83231012015b35d0b1db357f1f7c0)]
+- 🎨 List articles including article_extract.html [[cefe351](https://github.com/ivanhercaz/buruma/commit/cefe351b845648dde8978b55d978d8c44781d0f1)]
+- 🎨 Add a necessary close tag for a div [[7bda531](https://github.com/ivanhercaz/buruma/commit/7bda53133faa025c0e0d1d35a1500d39d832ebb0)]
+- 🎨 Create an easy to include template for articles [[66e503b](https://github.com/ivanhercaz/buruma/commit/66e503ba70976a1416300e264911f9cda9c6832a)]
+- 🔧 Fix version [[8fa2813](https://github.com/ivanhercaz/buruma/commit/8fa2813a7a6134378c9f30e6a89c77d868eb898d)]
+
+### Localizations/translations
+
+- 🌐 Add Spanish translation ([#11](https://github.com/ivanhercaz/buruma/issues/11)) [[05b90c3](https://github.com/ivanhercaz/buruma/commit/05b90c3a35184cc5d2b09e85a62733aec22bc265)]
+- 🌐 Add English translation ([#11](https://github.com/ivanhercaz/buruma/issues/11)) [[a2f79d5](https://github.com/ivanhercaz/buruma/commit/a2f79d53583731cc8219470b2790c5659bc3c5af)]
+- 🌐 Add extracted strings ([#11](https://github.com/ivanhercaz/buruma/issues/11)) [[705f406](https://github.com/ivanhercaz/buruma/commit/705f406e2539f7a1ba9c8b2d868b2d121a1a972e)]
+- 🌐 Fix extract and update instructions ([#11](https://github.com/ivanhercaz/buruma/issues/11)) [[577c8cc](https://github.com/ivanhercaz/buruma/commit/577c8cc201a8bc8c103c989f879940495c70e133)]
+- 🌐 Add Babel configuration ([#11](https://github.com/ivanhercaz/buruma/issues/11)) [[ff01ae5](https://github.com/ivanhercaz/buruma/commit/ff01ae557c054ef7c1f303ddf815a0155f7b8ec5)]
+- 🌐 Add Makefile to run the tasks easily ([#11](https://github.com/ivanhercaz/buruma/issues/11)) [[1cfdc83](https://github.com/ivanhercaz/buruma/commit/1cfdc8393ae9227a00a6fc64a34656e5122d36a2)]
+- 🌐 Localize translatable strings ([#8](https://github.com/ivanhercaz/buruma/issues/8)) [[feee462](https://github.com/ivanhercaz/buruma/commit/feee462a105a120918ec559d0c475cb4633695ca)]
+- 🌐 Localize translatable strings ([#8](https://github.com/ivanhercaz/buruma/issues/8)) [[c0a7080](https://github.com/ivanhercaz/buruma/commit/c0a708017c549416f159620073151f11623e1142)]
+- 🌐 Localize translatable strings ([#8](https://github.com/ivanhercaz/buruma/issues/8)) [[48dcbf5](https://github.com/ivanhercaz/buruma/commit/48dcbf586bff4e595faedb93d3fe1a87a9dff4fb)]
+- 🌐 Localize translatable strings ([#8](https://github.com/ivanhercaz/buruma/issues/8)) [[8dedc12](https://github.com/ivanhercaz/buruma/commit/8dedc1211150c635e4d38a6a999af86197e59736)]
+- 🌐 Mark translatable strings ([#8](https://github.com/ivanhercaz/buruma/issues/8)) [[000b127](https://github.com/ivanhercaz/buruma/commit/000b127534af4ff03645b41d8d7669d35f4d874e)]
+- 🌐 Add {{ LICENSE_NOTICE }} instead of raw license [[5e01c0a](https://github.com/ivanhercaz/buruma/commit/5e01c0aa8a8dc14bc3d58f7727200ef6a0bde005)]
+- 🌐 Localize and translate string [[05e46f8](https://github.com/ivanhercaz/buruma/commit/05e46f83dee50b4fdc9f8af444ae17c8e8f924fe)]
+- 🌐 Add details to English and Spanish translation [[758f1e5](https://github.com/ivanhercaz/buruma/commit/758f1e551ff0ee109cce860b4fe78fac4a0c228f)]
+
+### Documentation
+
+- 🔧 Remove items in the menu of the navbar [[49d26a2](https://github.com/ivanhercaz/buruma/commit/49d26a2366b68160100ec7583f15eb67b96526ab)]
+- 🔧 Fix an error in the extract. [[6aad9f1](https://github.com/ivanhercaz/buruma/commit/6aad9f1f767d90df1091f42696490382ee2605a1)]
+- 🔧 Apply is-primary to documentation category [[e023088](https://github.com/ivanhercaz/buruma/commit/e0230887f7a953f0f0b7c366be9c62afc8347521)]
+- 🔧 Update config variables and clean the file [[b1cdd15](https://github.com/ivanhercaz/buruma/commit/b1cdd15765dd795afdd320d50d38ba04672eabe6)]
+- 🔧 🚀 Add theme and plugins config ([#2](https://github.com/ivanhercaz/buruma/issues/2)) [[f5de764](https://github.com/ivanhercaz/buruma/commit/f5de7641449177139e1c8c9e4d77b75e98e148ea)]
+
+### Fixed
+
+- 🐛 Fix [#10](https://github.com/ivanhercaz/buruma/issues/10). Changes in href attr in a tag. [[493eb4a](https://github.com/ivanhercaz/buruma/commit/493eb4a42e712cc9055b744e123bf20940532c38)]
+- 🐛 Close not closed if statements and fix extends [[b73f151](https://github.com/ivanhercaz/buruma/commit/b73f15179f71cd622a1c2b900866f3d34bb10328)]
+- 🐛 Use article.url instead of article.slug (fix [#7](https://github.com/ivanhercaz/buruma/issues/7)) [[71dcc29](https://github.com/ivanhercaz/buruma/commit/71dcc29ab81b7d3bdc75a9abeac1f1e74c8df118)]
+
+### Miscellaneous
+
+- 📝 Fix some minor problems [[8c18d65](https://github.com/ivanhercaz/buruma/commit/8c18d65d997e1ccde0436c7d4743f0a30517fc96)]
+- 📝 Write a quickstart guide to use Buruma ([#2](https://github.com/ivanhercaz/buruma/issues/2)) [[2462400](https://github.com/ivanhercaz/buruma/commit/24624009c24dc22542e2dea06ad88d3fb5e7e891)]
+- 📝 Write docs for Buruma settings ([#2](https://github.com/ivanhercaz/buruma/issues/2)) [[7f9a67d](https://github.com/ivanhercaz/buruma/commit/7f9a67d35366388204824d35a88caf3a2dd96c23)]
+- 🙈 Ignore some Python/Pelican dirs [[9522521](https://github.com/ivanhercaz/buruma/commit/9522521c61cdc33c530a1d3fde926f568fa48cfe)]
+- 🚀 Remove plugins directory before to clone [[4004f25](https://github.com/ivanhercaz/buruma/commit/4004f25e483df4816db2316db9e0df0c4868a5b1)]
+- 🚀 Fix deploy on Netlify [[eb3dd4d](https://github.com/ivanhercaz/buruma/commit/eb3dd4daf160e0de2d8554bcdf7460bcfe7e9886)]
+- 🚀 Fix config to deploy /docs on Netlify [[59499d4](https://github.com/ivanhercaz/buruma/commit/59499d49d75fd3aeb0f727c6f9aefb177a0a1fb4)]
+- 📝 Add content to test the correct deployment ([#2](https://github.com/ivanhercaz/buruma/issues/2)) [[c5b67dd](https://github.com/ivanhercaz/buruma/commit/c5b67dd00c45b11fc29d12d555702066bc872769)]
+- 🚀 Add necessary files to deploy on Netlify ([#2](https://github.com/ivanhercaz/buruma/issues/2)) [[0097e64](https://github.com/ivanhercaz/buruma/commit/0097e6431d6ec9712450d79c609686254f334e70)]
+- 🚀 Fix Netlify building config ([#2](https://github.com/ivanhercaz/buruma/issues/2)) [[19d978e](https://github.com/ivanhercaz/buruma/commit/19d978e6651dccda60cabad47b0b2431dd9748c7)]
+- 🚀 Add Pelican structure for /docs deploy ([#2](https://github.com/ivanhercaz/buruma/issues/2)) [[f8b6b90](https://github.com/ivanhercaz/buruma/commit/f8b6b90ff83a46e5b4a833eeae3d973f6c8ecfe5)]
+- 🚀 Add Makefile to generate and deploy /docs ([#2](https://github.com/ivanhercaz/buruma/issues/2)) [[dbc1d32](https://github.com/ivanhercaz/buruma/commit/dbc1d3221061c8c7eee3f00d7b6a227f8549fdea)]
+- 🚀 Add Netlify configuration for /docs ([#2](https://github.com/ivanhercaz/buruma/issues/2)) [[12f8a4b](https://github.com/ivanhercaz/buruma/commit/12f8a4b17138fc1248af2f76a6d28f8cabe8d236)]
+- 📝 Add warning about jinja.ext.i18n ([#8](https://github.com/ivanhercaz/buruma/issues/8)) [[2813013](https://github.com/ivanhercaz/buruma/commit/2813013d372fb7a2593bc94996867b0fa34dbf3d)]
+- 🙈 Ignore CSS files. [[53db292](https://github.com/ivanhercaz/buruma/commit/53db292bba9a0249a9a202f7fdb61802da720d33)]
+- 📝 Indicate some specifications in the README. [[ecdf29d](https://github.com/ivanhercaz/buruma/commit/ecdf29d052aff6d1341c1ed9e0fcaaf68e0225c8)]
+
+
+<a name="0.1.0-alpha"></a>
+## 0.1.0-alpha (2019-12-06)
+
+### Changed
+
+- 🔧 Add package.json [[b258c41](https://github.com/ivanhercaz/buruma/commit/b258c41d6dbfececbeb07bec4f05365679773bec)]
+- 💄 Add some basic templates [[fc1f122](https://github.com/ivanhercaz/buruma/commit/fc1f122934aed5a7d6264a0a799205ce9561fc53)]
+- 💄 Add initial static files [[e9c9c02](https://github.com/ivanhercaz/buruma/commit/e9c9c02b86fe84b5631cf90093b90102b5cf13ee)]
+
+### Fixed
+
+- ✏️ Fix typo [[805f874](https://github.com/ivanhercaz/buruma/commit/805f874e3936e0e5b8b533236681f284cff1b9f7)]
+
+### Miscellaneous
+
+- 🙈 Ignore node_modules and package-lock.json [[75ca11e](https://github.com/ivanhercaz/buruma/commit/75ca11e0906d8750f0b772690d695e8e63c4cf66)]
+- 📝 Improve README [[fbbc3e1](https://github.com/ivanhercaz/buruma/commit/fbbc3e150c1a2c35b60ceec88b3b6d14dc9626b8)]
+-  Initial commit [[38ebe39](https://github.com/ivanhercaz/buruma/commit/38ebe39dab68101bd082d8272c7a3716f7cd3c2e)]
+
+
diff --git a/README.md b/README.md
@@ -2,22 +2,30 @@
 
 Buruma is a [Pelican](https://github.com/getpelican/pelican) theme built with the CSS framework [Bulma](https://bulma.io).
 
-I am still working in the release of the first version (0.1.0). You can check the [0.1.0 milestone](https://github.com/ivanhercaz/buruma/milestone/1) done to track this version.
+The current version is the 0.1.0. Before this one Buruma was in [0.1.0-alpha](https://github.com/ivanhercaz/buruma/releases/tag/0.1.0-alpha), not recommended for production. 
 
-**Buruma is not ready for production!** The current version of Buruma is [0.1.0-alpha](https://github.com/ivanhercaz/buruma/releases/tag/0.1.0-alpha). I don't know if I will release different alpha versions during the process of development or if I will release an stable version (0.1.0). Anyway you can check the [releases](https://github.com/ivanhercaz/buruma/releases) to be sure that 0.1.0-alpha is the latest release or you can clone this repository. 
+If you want to use Buruma, I recommend you to read the available [quickstart](https://buruma.ivanhercaz.com/quickstart) in the documentation website, because it might help you to decide if Buruma is fine for you at this moment.
 
-# Where you can see Buruma
+## Documentation
 
-Buruma is being used just for me. If you want, you can check my [personal website](https://ivanhercaz.com). I will always the last version of Buruma to test it.
+It is available in the [documentation website](https://buruma.ivanhercaz.com). If you want to test Buruma, you may be interested in the [quickstart](https://buruma.ivanhercaz.com/quickstart). There is a page dedicated to Buruma [settings](https://buruma.ivanhercaz.com/settings.html).
 
-# Configuration
+If you note a lack in the documentation, please feel free to [open an issue!](https://github.com/ivanhercaz/buruma/issues/new).
 
-If you want to set a different language than English, you need to add the i18n extension for Jinja2:
+## Demo website
 
-```python
-JINJA_ENVIRONMENT = {
-  'extensions': ['jinja2.ext.i18n', ...]
-}
-```
+You can check Buruma in its [demo website](https://netlify--affectionate-hypatia-0ab213.netlify.com/). It is deployed on Netlify and it always use the last stable release (not alpha nor beta).
 
-**Pending to improve**
+If you want to check a website using Buruma updated to the master branch of this repository, you can check the [documentation](https://buruma.ivanhercaz.com). 
+
+## Contributing
+
+The contributing guidelines are not written yet, but if you want to contribute to Buruma in any way, do it! Your contributions will be very welcome!
+
+## Credits
+
+Buruma is possible thanks to [Jeremy Thomas](https://jgthms.com/), creator of [Bulma](https://bulma.io), released under the [MIT license](https://github.com/jgthms/bulma/blob/master/LICENSE). Of course, Buruma exists because [Pelican](https://getpelican.com) exists! An awesome and easy to use static site generator.
+
+## License
+
+Buruma is under [GNU Affero General Public License v3.0](https://github.com/ivanhercaz/buruma/blob/master/LICENSE). Should Buruma be under another license? If you think that, feel free to open an issue to discuss it!
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "buruma",
-  "version": "0.1.0-alpha",
+  "version": "0.1.0",
   "description": "a Pelican theme with Bulma (CSS Framework)",
   "scripts": {
     "css-build": "node-sass --omit-source-map-url static/scss/style.scss static/css/style.min.css --output-style compressed",