From 6d518c27ee133c5e26faca36d31a953842bb0e2a Mon Sep 17 00:00:00 2001 From: Petar Kirov Date: Tue, 16 May 2017 23:02:26 +0300 Subject: [PATCH] Update readme (#55) * Update README.rst and dub.json * Remove dead documentation links in the readme file --- README.rst | 24 ++++++++++-------------- dub.json | 4 ++-- 2 files changed, 12 insertions(+), 16 deletions(-) diff --git a/README.rst b/README.rst index 7d9f3d3..d6a6151 100644 --- a/README.rst +++ b/README.rst @@ -2,16 +2,13 @@ D:YAML 0.5 ========== -This is a fork of the D:YAML library by kiith-sa (https://github.com/kiith-sa/D-YAML). -The intent of this fork is to provide a version suitable for use by dlang-tour, until -fixes are accepted upstream. - -.. image:: https://travis-ci.org/dlang-tour/dyaml-dlang-tour.svg?branch=master -.. image:: https://img.shields.io/dub/v/dyaml-dlang-tour.svg - :target: http://code.dlang.org/packages/dyaml-dlang-tour +.. image:: https://travis-ci.org/dlang-community/D-YAML.svg?branch=master + :target: https://travis-ci.org/dlang-community/D-YAML +.. image:: https://img.shields.io/dub/v/dyaml.svg + :target: http://code.dlang.org/packages/dyaml **Note**: D:YAML 0.5 brings some **breaking changes**. See the -`changelog `_. +`changelog `_. ------------ Introduction @@ -19,14 +16,14 @@ Introduction D:YAML is an open source YAML parser and emitter library for the D programming language. It is -(`almost `_) +(`almost `_) compliant to the YAML 1.1 specification. D:YAML is based on `PyYAML `_ created by Kirill Simonov. D:YAML is designed to be easy to use while supporting the full feature set of YAML. To start using it in your project, see the -`Getting Started `_ -tutorial and the `documentation `_. +`Getting Started `_ +tutorial. D:YAML is still a work in progress. Its API is not stable and there might be compatibility breaking changes. @@ -80,11 +77,10 @@ Installing and tutorial ----------------------- See the -`Getting Started `_ +`Getting Started `_ tutorial and other tutorials that can be found at the -`GitHub wiki `_ +`GitHub wiki `_ and in the ``doc/html/tutorials/`` directory in the package. -For advanced usage, see the `documentation `_. ------- diff --git a/dub.json b/dub.json index aff9cdf..37e739d 100644 --- a/dub.json +++ b/dub.json @@ -1,12 +1,12 @@ { - "name": "dyaml-dlang-tour", + "name": "dyaml", "description": "YAML parser and emitter", "authors": [ "Ferdinand Majerech" ], "libs": [], "importPaths": ["source"], "license": "Boost 1.0", "dependencies": { "tinyendian" : { "version" : "~>0.1.0" } }, - "homepage": "https://github.com/kiith-sa/D-YAML", + "homepage": "https://github.com/dlang-community/D-YAML", "copyright": "Copyright © 2011-2014, Ferdinand Majerech", "buildTypes":